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

#include <mrpt/utils/CSimpleDatabase.h>

Inheritance diagram for mrpt::utils::CSimpleDatabase:

[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::exception On 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::exception On 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.

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).

CObject * clone () const

Cloning interface for smart pointers.

Static Public Attributes

static const
mrpt::utils::TRuntimeClassId classCObject

Protected Member Functions

virtual void writeToStream (mrpt::utils::CStream &out, int *getVersion) const =0

Introduces a pure virtual method responsible for writing to a CStream.

virtual void readFromStream (mrpt::utils::CStream &in, int version)=0

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.

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

static const
mrpt::utils::TRuntimeClassId classCSerializable

class mrpt::utils::CStream

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::CObject * duplicate () const

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

static mrpt::utils::CObject * CreateObject ()

static CSimpleDatabasePtr Create ()

Member Typedef Documentation

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

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.

typedef CSimpleDatabasePtr mrpt::utils::CSimpleDatabase::SmartPtr

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.

CObject* mrpt::utils::CObject::clone ( ) const [inline, inherited]

Cloning interface for smart pointers.

Reimplemented in mrpt::opengl::CRenderizable, and mrpt::opengl::CRenderizableDisplayList.

Definition at line 154 of file CObject.h.

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::exception On 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.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const [inline, inherited]

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).

Definition at line 151 of file CObject.h.

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::exception On table not found.

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

Returns the table by index.

Exceptions:

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.

Returns:: false on any error, true if successful.

See also:: saveAsXML

virtual void mrpt::utils::CSerializable::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)		`[protected, pure virtual, inherited]`

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.

Parameters:

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.

Exceptions:

std::exception On any error, see CStream::ReadBuffer

See also:: CStream

Implemented in mrpt::math::CMatrixD, and mrpt::math::CMatrix.

void mrpt::utils::CSimpleDatabase::renameTable	(	const std::string &	tableName,
		const std::string &	newTableName
	)

Changes the name of a given table

Exceptions:

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.

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::exception On index out of bounds

virtual void mrpt::utils::CSerializable::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const `[protected, pure virtual, inherited]`

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.

Parameters:

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.

Exceptions:

std::exception On any error, see CStream::WriteBuffer