This class impements a very simple database system.
A database is a collection of tables, each one being a CSimpleDatabaseTable object. Tables are a rectangular arrrangement of cells, organized as records of fields. There are XML export/import methods in saveAsXML, loadFromXML.
Definition at line 122 of file CSimpleDatabase.h.
#include <mrpt/utils/CSimpleDatabase.h>
Public Member Functions | |||
void * | operator new (size_t size) | ||
void * | operator new[] (size_t size) | ||
void | operator delete (void *ptr) throw () | ||
void | operator delete[] (void *ptr) throw () | ||
void | operator delete (void *memory, void *ptr) throw () | ||
void * | operator new (size_t size, const std::nothrow_t &) throw () | ||
void | operator delete (void *ptr, const std::nothrow_t &) throw () | ||
CSimpleDatabase () | |||
Default constructor. More... | |||
virtual | ~CSimpleDatabase () | ||
Destructor. More... | |||
void | clear () | ||
Clears the DB. More... | |||
CSimpleDatabaseTablePtr | createTable (const std::string &name) | ||
Creates a new table in the DB, initially empty. More... | |||
CSimpleDatabaseTablePtr | getTable (const std::string &tableName) | ||
Returns the table with the indicated name
| |||
void | dropTable (const std::string &tableName) | ||
Deletes the given table. More... | |||
void | renameTable (const std::string &tableName, const std::string &newTableName) | ||
Changes the name of a given table
| |||
CSimpleDatabaseTablePtr | getTable (size_t tableIndex) | ||
Returns the table by index. More... | |||
size_t | tablesCount () const | ||
Returns the tables count in the DB. More... | |||
std::string | tablesName (size_t tableIndex) const | ||
Returns the tables names in the DB. More... | |||
bool | saveAsXML (const std::string &fileName) const | ||
Saves this database as a XML file. More... | |||
bool | loadFromXML (const std::string &fileName) | ||
Loads the content of this database from a a XML file. More... | |||
virtual mxArray * | writeToMatlab () const | ||
Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class. More... | |||
mrpt::utils::CObjectPtr | duplicateGetSmartPtr () const | ||
Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More... | |||
CObject * | clone () const | ||
Cloning interface for smart pointers. More... | |||
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Static Public Attributes | |
static const mrpt::utils::TRuntimeClassId | classCObject |
RTTI stuff | |
static const mrpt::utils::TRuntimeClassId | classCSerializable |
Protected Member Functions | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More... | |
Private Types | |
typedef std::map< std::string, CSimpleDatabaseTablePtr > | TTableList |
The tables of the DB indexed by their names: More... | |
typedef std::map< std::string, CSimpleDatabaseTablePtr >::iterator | iterator |
typedef std::map< std::string, CSimpleDatabaseTablePtr >::const_iterator | const_iterator |
Private Attributes | |
TTableList | m_tables |
RTTI stuff | |
typedef CSimpleDatabasePtr | SmartPtr |
static mrpt::utils::CLASSINIT | _init_CSimpleDatabase |
static mrpt::utils::TRuntimeClassId | classCSimpleDatabase |
static const mrpt::utils::TRuntimeClassId * | classinfo |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | duplicate () const |
Returns a copy of the object, indepently of its class. More... | |
static mrpt::utils::CObject * | CreateObject () |
static CSimpleDatabasePtr | Create () |
|
private |
Definition at line 193 of file CSimpleDatabase.h.
|
private |
Definition at line 192 of file CSimpleDatabase.h.
typedef CSimpleDatabasePtr mrpt::utils::CSimpleDatabase::SmartPtr |
A typedef for the associated smart pointer
Definition at line 125 of file CSimpleDatabase.h.
|
private |
The tables of the DB indexed by their names:
Definition at line 191 of file CSimpleDatabase.h.
mrpt::utils::CSimpleDatabase::CSimpleDatabase | ( | ) |
Default constructor.
|
virtual |
Destructor.
|
staticprotected |
void mrpt::utils::CSimpleDatabase::clear | ( | ) |
Clears the DB.
|
inlineinherited |
|
static |
|
static |
CSimpleDatabaseTablePtr mrpt::utils::CSimpleDatabase::createTable | ( | const std::string & | name | ) |
Creates a new table in the DB, initially empty.
void mrpt::utils::CSimpleDatabase::dropTable | ( | const std::string & | tableName | ) |
Deletes the given table.
std::exception | On table not found. |
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
virtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
CSimpleDatabaseTablePtr mrpt::utils::CSimpleDatabase::getTable | ( | const std::string & | tableName | ) |
Returns the table with the indicated name
std::exception | On table not found. |
CSimpleDatabaseTablePtr mrpt::utils::CSimpleDatabase::getTable | ( | size_t | tableIndex | ) |
Returns the table by index.
std::exception | On index out of bounds |
bool mrpt::utils::CSimpleDatabase::loadFromXML | ( | const std::string & | fileName | ) |
Loads the content of this database from a a XML file.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
inlinestatic |
Definition at line 125 of file CSimpleDatabase.h.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
inline |
Definition at line 125 of file CSimpleDatabase.h.
|
protectedvirtual |
Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.
in | The input binary stream where the object data must read from. |
version | The version of the object stored in the stream: use this version number in your code to know how to read the incoming data. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
void mrpt::utils::CSimpleDatabase::renameTable | ( | const std::string & | tableName, |
const std::string & | newTableName | ||
) |
Changes the name of a given table
std::exception | On table not found or new name already existed. |
bool mrpt::utils::CSimpleDatabase::saveAsXML | ( | const std::string & | fileName | ) | const |
Saves this database as a XML file.
size_t mrpt::utils::CSimpleDatabase::tablesCount | ( | ) | const |
Returns the tables count in the DB.
std::string mrpt::utils::CSimpleDatabase::tablesName | ( | size_t | tableIndex | ) | const |
Returns the tables names in the DB.
std::exception | On index out of bounds |
|
inlinevirtualinherited |
Introduces a pure virtual method responsible for writing to a mxArray
Matlab object, typically a MATLAB struct
whose contents are documented in each derived class.
mxArray
(caller is responsible of memory freeing) or NULL is class does not support conversion to MATLAB. Definition at line 79 of file CSerializable.h.
|
protectedvirtual |
Introduces a pure virtual method responsible for writing to a CStream.
This can not be used directly be users, instead use "stream << object;" for writing it to a stream.
out | The output binary stream where object must be dumped. |
getVersion | If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
staticprotected |
Definition at line 125 of file CSimpleDatabase.h.
|
staticinherited |
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 125 of file CSimpleDatabase.h.
|
static |
Definition at line 125 of file CSimpleDatabase.h.
|
private |
Definition at line 195 of file CSimpleDatabase.h.
Page generated by Doxygen 1.8.9.1 for MRPT 1.3.2 SVN:Unversioned directory at Thu Dec 10 00:07:55 UTC 2015 |