Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Private Types | Private Attributes

mrpt::utils::CSimpleDatabase Class Reference


Detailed Description

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.

Note:
This class is NOT safe for read/write access from different threads. If needed, use critical sections.
See also:
CSimpleDatabaseTable

Definition at line 140 of file CSimpleDatabase.h.

#include <mrpt/utils/CSimpleDatabase.h>

Inheritance diagram for mrpt::utils::CSimpleDatabase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CSimpleDatabase ()
 Default constructor.
virtual ~CSimpleDatabase ()
 Destructor.
void clear ()
 Clears the DB.
CSimpleDatabaseTablePtr createTable (const std::string &name)
 Creates a new table in the DB, initially empty.
CSimpleDatabaseTablePtr getTable (const std::string &tableName)
 Returns the table with the indicated name

Exceptions:
std::exceptionOn table not found.

void dropTable (const std::string &tableName)
 Deletes the given table.
void renameTable (const std::string &tableName, const std::string &newTableName)
 Changes the name of a given table

Exceptions:
std::exceptionOn table not found or new name already existed.

CSimpleDatabaseTablePtr getTable (size_t tableIndex)
 Returns the table by index.
size_t tablesCount () const
 Returns the tables count in the DB.
std::string tablesName (size_t tableIndex) const
 Returns the tables names in the DB.
bool saveAsXML (const std::string &fileName) const
 Saves this database as a XML file.
bool loadFromXML (const std::string &fileName)
 Loads the content of this database from a a XML file.

Private Types

typedef std::map< std::string,
CSimpleDatabaseTablePtr
TTableList
 The tables of the DB indexed by their names:
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.
virtual mrpt::utils::CObjectduplicate () const
 Returns a copy of the object, indepently of its class.
static mrpt::utils::CObjectCreateObject ()
static CSimpleDatabasePtr Create ()

Member Typedef Documentation

Definition at line 211 of file CSimpleDatabase.h.

typedef std::map<std::string, CSimpleDatabaseTablePtr>::iterator mrpt::utils::CSimpleDatabase::iterator [private]

Definition at line 210 of file CSimpleDatabase.h.

A typedef for the associated smart pointer

Definition at line 143 of file CSimpleDatabase.h.

typedef std::map<std::string, CSimpleDatabaseTablePtr> mrpt::utils::CSimpleDatabase::TTableList [private]

The tables of the DB indexed by their names:

Definition at line 209 of file CSimpleDatabase.h.


Constructor & Destructor Documentation

mrpt::utils::CSimpleDatabase::CSimpleDatabase (  )

Default constructor.

virtual mrpt::utils::CSimpleDatabase::~CSimpleDatabase (  ) [virtual]

Destructor.


Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CSimpleDatabase::_GetBaseClass (  ) [static, protected]

Reimplemented from mrpt::utils::CSerializable.

void mrpt::utils::CSimpleDatabase::clear (  )

Clears the DB.

static CSimpleDatabasePtr mrpt::utils::CSimpleDatabase::Create (  ) [static]
static mrpt::utils::CObject* mrpt::utils::CSimpleDatabase::CreateObject (  ) [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.

Exceptions:
std::exceptionOn table not found.
virtual mrpt::utils::CObject* mrpt::utils::CSimpleDatabase::duplicate (  ) const [virtual]

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

virtual const mrpt::utils::TRuntimeClassId* mrpt::utils::CSimpleDatabase::GetRuntimeClass (  ) const [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

Exceptions:
std::exceptionOn table not found.

CSimpleDatabaseTablePtr mrpt::utils::CSimpleDatabase::getTable ( size_t  tableIndex )

Returns the table by index.

Exceptions:
std::exceptionOn index out of bounds
bool mrpt::utils::CSimpleDatabase::loadFromXML ( const std::string &  fileName )

Loads the content of this database from a a XML file.

Returns:
false on any error, true if successful.
See also:
saveAsXML
void mrpt::utils::CSimpleDatabase::renameTable ( const std::string &  tableName,
const std::string &  newTableName 
)

Changes the name of a given table

Exceptions:
std::exceptionOn 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.

Returns:
false on any error, true if successful.
See also:
loadFromXML
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.

Exceptions:
std::exceptionOn index out of bounds

Member Data Documentation

Definition at line 143 of file CSimpleDatabase.h.

Definition at line 143 of file CSimpleDatabase.h.

Definition at line 143 of file CSimpleDatabase.h.

Definition at line 213 of file CSimpleDatabase.h.




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:46:17 UTC 2011