Detailed Description

This class implements the tables of databases.

See also: CSimpleDatabase

Definition at line 19 of file CSimpleDatabase.h.

#include <mrpt/db/CSimpleDatabase.h>

Inheritance diagram for mrpt::db::CSimpleDatabaseTable:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

	CSimpleDatabaseTable ()
	Default constructor. More...

virtual	~CSimpleDatabaseTable ()
	Destructor. More...

size_t	fieldsCount () const
	Get the count of fields. More...

size_t	appendRecord ()
	Append a new and empty record at the end of the table, and return the index of the newly added record. More...

void	addField (const char *fieldName)
	Add a new field to the table. More...

void	addField (const std::string &fieldName)
	Add a new field to the table. More...

std::string	getFieldName (size_t fieldIndex) const
	Get the name of a field by its index. More...

size_t	fieldIndex (const char *fieldName) const
	Get the index for a given field name. More...

size_t	fieldIndex (const std::string &fieldName) const
	Get the index for a given field name. More...

size_t	getRecordCount () const
	Get the records count in the table. More...

std::string	get (size_t recordIndex, std::string field) const
	Returns the cell content of the record indicates by its index, and the field indicated in "field". More...

std::string	get (size_t recordIndex, size_t fieldIndex) const
	Returns the cell content of the record indicates by its index, and the field indicated by its index. More...

void	set (size_t recordIndex, std::string field, std::string value)
	Sets the cell content of the record indicates by its index, and the field indicated in "field". More...

void	set (size_t recordIndex, size_t fieldIndex, std::string value)
	Sets the cell content of the record indicates by its index, and the field indicated by its index. More...

int	query (std::string field, std::string value) const
	Executes a query in the table, returning the record index which a given field has a given value, case insensitive, or -1 if not found. More...

void	deleteRecord (size_t recordIndex)
	Delete the record at the given index. 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...

RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	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...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Protected Member Functions
CSerializable virtual methods
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...

void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...

void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...

Private Attributes
std::vector< std::string >	field_names
	Field names. More...

std::vector< std::vector< std::string > >	data
	Data for each cell. More...

RTTI stuff
using	Ptr = std::shared_ptr< CSimpleDatabaseTable >

using	ConstPtr = std::shared_ptr< const CSimpleDatabaseTable >

using	UniquePtr = std::unique_ptr< CSimpleDatabaseTable >

using	ConstUniquePtr = std::unique_ptr< const CSimpleDatabaseTable >

static mrpt::rtti::CLASSINIT	_init_CSimpleDatabaseTable

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CSimpleDatabaseTable"

static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()

static constexpr auto	getClassName ()

static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()

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

template<typename... Args>
static Ptr	Create (Args &&... args)

template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)

virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::rtti::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ ConstPtr

using mrpt::db::CSimpleDatabaseTable::ConstPtr = std::shared_ptr<const CSimpleDatabaseTable >

Definition at line 21 of file CSimpleDatabase.h.

◆ ConstUniquePtr

using mrpt::db::CSimpleDatabaseTable::ConstUniquePtr = std::unique_ptr<const CSimpleDatabaseTable >

Definition at line 21 of file CSimpleDatabase.h.

◆ Ptr

using mrpt::db::CSimpleDatabaseTable::Ptr = std::shared_ptr< CSimpleDatabaseTable >

A type for the associated smart pointer

Definition at line 21 of file CSimpleDatabase.h.

◆ UniquePtr

using mrpt::db::CSimpleDatabaseTable::UniquePtr = std::unique_ptr< CSimpleDatabaseTable >

Definition at line 21 of file CSimpleDatabase.h.

Constructor & Destructor Documentation

◆ CSimpleDatabaseTable()

CSimpleDatabaseTable::CSimpleDatabaseTable ( )

Default constructor.

Definition at line 195 of file CSimpleDatabase.cpp.

◆ ~CSimpleDatabaseTable()

CSimpleDatabaseTable::~CSimpleDatabaseTable ( )

virtual

Destructor.

Definition at line 199 of file CSimpleDatabase.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::db::CSimpleDatabaseTable::_GetBaseClass ( )

staticprotected

◆ addField() [1/2]

void CSimpleDatabaseTable::addField ( const char * fieldName )

Add a new field to the table.

The table is cleared in this operation.

Definition at line 207 of file CSimpleDatabase.cpp.

◆ addField() [2/2]

void mrpt::db::CSimpleDatabaseTable::addField ( const std::string & fieldName )

inline

Add a new field to the table.

The table is cleared in this operation.

Definition at line 45 of file CSimpleDatabase.h.

References addField().

Referenced by addField().

◆ appendRecord()

size_t CSimpleDatabaseTable::appendRecord ( )

Append a new and empty record at the end of the table, and return the index of the newly added record.

See also: deleteRecord

Definition at line 326 of file CSimpleDatabase.cpp.

◆ clone()

virtual mrpt::rtti::CObject* mrpt::db::CSimpleDatabaseTable::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::rtti::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::db::CSimpleDatabaseTable::Create ( Args &&... args )

inlinestatic

Definition at line 21 of file CSimpleDatabase.h.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::db::CSimpleDatabaseTable::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::db::CSimpleDatabaseTable::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 21 of file CSimpleDatabase.h.

◆ deleteRecord()

void CSimpleDatabaseTable::deleteRecord ( size_t recordIndex )

Delete the record at the given index.

See also: appendRecord

Definition at line 339 of file CSimpleDatabase.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

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 168 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

◆ fieldIndex() [1/2]

size_t CSimpleDatabaseTable::fieldIndex ( const char * fieldName ) const

Get the index for a given field name.

Exceptions

std::exception On field not found

Definition at line 229 of file CSimpleDatabase.cpp.

References mrpt::system::os::_strcmpi(), MRPT_END, MRPT_START, and THROW_EXCEPTION_FMT.

Referenced by fieldIndex().

◆ fieldIndex() [2/2]

size_t mrpt::db::CSimpleDatabaseTable::fieldIndex ( const std::string & fieldName ) const

inline

Get the index for a given field name.

Exceptions

std::exception On field not found

Definition at line 59 of file CSimpleDatabase.h.

References fieldIndex().

◆ fieldsCount()

size_t CSimpleDatabaseTable::fieldsCount ( ) const

Get the count of fields.

Definition at line 203 of file CSimpleDatabase.cpp.

◆ get() [1/2]

string CSimpleDatabaseTable::get	(	size_t	recordIndex,
		std::string	field
	)		const

Returns the cell content of the record indicates by its index, and the field indicated in "field".

Exceptions

std::exception On field or record not found

Definition at line 250 of file CSimpleDatabase.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ get() [2/2]

string CSimpleDatabaseTable::get	(	size_t	recordIndex,
		size_t	fieldIndex
	)		const

Returns the cell content of the record indicates by its index, and the field indicated by its index.

Exceptions

std::exception On field or record not found

Definition at line 261 of file CSimpleDatabase.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ getClassName()

static constexpr auto mrpt::db::CSimpleDatabaseTable::getClassName ( )

inlinestatic

Definition at line 21 of file CSimpleDatabase.h.

◆ getFieldName()

string CSimpleDatabaseTable::getFieldName ( size_t fieldIndex ) const

Get the name of a field by its index.

Exceptions

std::exception On index out of bounds

Definition at line 216 of file CSimpleDatabase.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ getRecordCount()

size_t CSimpleDatabaseTable::getRecordCount ( ) const

Get the records count in the table.

Definition at line 246 of file CSimpleDatabase.cpp.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::db::CSimpleDatabaseTable::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::db::CSimpleDatabaseTable::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::db::CSimpleDatabaseTable::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 21 of file CSimpleDatabase.h.

◆ operator delete() [2/3]

void mrpt::db::CSimpleDatabaseTable::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 21 of file CSimpleDatabase.h.

◆ operator delete() [3/3]

void mrpt::db::CSimpleDatabaseTable::operator delete ( void * ptr )

inlinenoexcept

Definition at line 21 of file CSimpleDatabase.h.

◆ operator delete[]()

void mrpt::db::CSimpleDatabaseTable::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 21 of file CSimpleDatabase.h.

◆ operator new() [1/3]

void* mrpt::db::CSimpleDatabaseTable::operator new ( size_t size )

inline

Definition at line 21 of file CSimpleDatabase.h.

◆ operator new() [2/3]

static void* mrpt::db::CSimpleDatabaseTable::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 21 of file CSimpleDatabase.h.

◆ operator new() [3/3]

void* mrpt::db::CSimpleDatabaseTable::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 21 of file CSimpleDatabase.h.

◆ operator new[]()

void* mrpt::db::CSimpleDatabaseTable::operator new[] ( size_t size )

inline

Definition at line 21 of file CSimpleDatabase.h.

◆ query()

int CSimpleDatabaseTable::query	(	std::string	field,
		std::string	value
	)		const

Executes a query in the table, returning the record index which a given field has a given value, case insensitive, or -1 if not found.

Definition at line 301 of file CSimpleDatabase.cpp.

References mrpt::system::os::_strcmpi().

◆ serializeFrom()

void CSimpleDatabaseTable::serializeFrom	(	mrpt::serialization::CArchive &	in,
		uint8_t	serial_version
	)

overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 89 of file CSimpleDatabase.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeGetVersion()

uint8_t CSimpleDatabaseTable::serializeGetVersion ( ) const

overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 76 of file CSimpleDatabase.cpp.

◆ serializeTo()

void CSimpleDatabaseTable::serializeTo ( mrpt::serialization::CArchive & out ) const

overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 77 of file CSimpleDatabase.cpp.

◆ set() [1/2]

void CSimpleDatabaseTable::set	(	size_t	recordIndex,
		std::string	field,
		std::string	value
	)

Sets the cell content of the record indicates by its index, and the field indicated in "field".

Exceptions

std::exception On field or record not found

Definition at line 273 of file CSimpleDatabase.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ set() [2/2]

void CSimpleDatabaseTable::set	(	size_t	recordIndex,
		size_t	fieldIndex,
		std::string	value
	)

Sets the cell content of the record indicates by its index, and the field indicated by its index.

Exceptions

std::exception On field or record not found

Definition at line 286 of file CSimpleDatabase.cpp.

References ASSERT_, MRPT_END, and MRPT_START.

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::CSerializable::writeToMatlab ( ) const

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.

Returns: A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 68 of file CSerializable.h.

Member Data Documentation

◆ _init_CSimpleDatabaseTable

mrpt::rtti::CLASSINIT mrpt::db::CSimpleDatabaseTable::_init_CSimpleDatabaseTable

staticprotected

Definition at line 21 of file CSimpleDatabase.h.

◆ className

constexpr const char* mrpt::db::CSimpleDatabaseTable::className = "CSimpleDatabaseTable"

static

Definition at line 21 of file CSimpleDatabase.h.

◆ data

std::vector<std::vector<std::string> > mrpt::db::CSimpleDatabaseTable::data

private

Data for each cell.

Definition at line 104 of file CSimpleDatabase.h.

◆ field_names

std::vector<std::string> mrpt::db::CSimpleDatabaseTable::field_names

private

Field names.

Definition at line 102 of file CSimpleDatabase.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::db::CSimpleDatabaseTable::runtimeClassId

staticprotected

Definition at line 21 of file CSimpleDatabase.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CSimpleDatabaseTable()

◆ ~CSimpleDatabaseTable()

Member Function Documentation

◆ _GetBaseClass()

◆ addField() [1/2]

◆ addField() [2/2]

◆ appendRecord()

◆ clone()

◆ Create()

◆ CreateObject()

◆ CreateUnique()

◆ deleteRecord()

◆ duplicateGetSmartPtr()

◆ fieldIndex() [1/2]

◆ fieldIndex() [2/2]

◆ fieldsCount()

◆ get() [1/2]

◆ get() [2/2]

◆ getClassName()

◆ getFieldName()

◆ getRecordCount()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ query()

◆ serializeFrom()

◆ serializeGetVersion()

◆ serializeTo()

◆ set() [1/2]

◆ set() [2/2]

◆ writeToMatlab()

Member Data Documentation

◆ _init_CSimpleDatabaseTable

◆ className

◆ data

◆ field_names

◆ runtimeClassId