Detailed Description

An arbitrary list of "annotations", or named attributes, each being an instance of any CSerializable object.

A multi-hypotheses version exists in CMHPropertiesValuesList.

See also: CSerializable, CMHPropertiesValuesList, mrpt::utils::TParameters

Definition at line 26 of file CPropertiesValuesList.h.

#include <mrpt/utils/CPropertiesValuesList.h>

Inheritance diagram for mrpt::utils::CPropertiesValuesList:

Classes
struct	TPropertyValuePair

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

	CPropertiesValuesList ()
	Default constructor. More...

	CPropertiesValuesList (const CPropertiesValuesList &o)
	Copy constructor. More...

CPropertiesValuesList &	operator= (const CPropertiesValuesList &o)
	Copy operator. More...

virtual	~CPropertiesValuesList ()
	Destructor. More...

void	clear ()
	Clears the list. More...

CSerializablePtr	get (const std::string &propertyName) const
	Returns the value of the property (case insensitive), or NULL if it does not exist. More...

void	set (const std::string &propertyName, const CSerializablePtr &obj)
	Sets/change the value of the property (case insensitive), making a copy of the object (or setting it to NULL if it is the passed value) More...

size_t	size () const
	Returns the number of properties in the list. More...

std::vector< std::string >	getPropertyNames () const
	Returns the name of all properties in the list. 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...

Protected Attributes
std::vector< TPropertyValuePair >	m_properties
	The properties list: a map between strings and objects. More...

RTTI stuff
typedef CPropertiesValuesListPtr	Ptr

typedef CPropertiesValuesListPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_CPropertiesValuesList

static mrpt::utils::TRuntimeClassId	classCPropertiesValuesList

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 CPropertiesValuesListPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef CPropertiesValuesListPtr mrpt::utils::CPropertiesValuesList::ConstPtr

Definition at line 29 of file CPropertiesValuesList.h.

◆ Ptr

typedef CPropertiesValuesListPtr mrpt::utils::CPropertiesValuesList::Ptr

A typedef for the associated smart pointer

Definition at line 29 of file CPropertiesValuesList.h.

Constructor & Destructor Documentation

◆ CPropertiesValuesList() [1/2]

CPropertiesValuesList::CPropertiesValuesList ( )

Default constructor.

Definition at line 97 of file CPropertiesValuesList.cpp.

◆ CPropertiesValuesList() [2/2]

CPropertiesValuesList::CPropertiesValuesList ( const CPropertiesValuesList & o )

Copy constructor.

Definition at line 112 of file CPropertiesValuesList.cpp.

References m_properties.

◆ ~CPropertiesValuesList()

CPropertiesValuesList::~CPropertiesValuesList ( )

virtual

Destructor.

Definition at line 104 of file CPropertiesValuesList.cpp.

References mrpt::utils::clear().

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CPropertiesValuesList::_GetBaseClass ( )

staticprotected

◆ clear()

void CPropertiesValuesList::clear ( )

Clears the list.

Definition at line 136 of file CPropertiesValuesList.cpp.

References m_properties, MRPT_END, and MRPT_START.

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 143 of file CObject.h.

◆ Create()

static CPropertiesValuesListPtr mrpt::utils::CPropertiesValuesList::Create ( )

static

◆ CreateObject()

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

static

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::utils::CPropertiesValuesList::duplicate ( ) const

virtual

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

Implements mrpt::utils::CObject.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr mrpt::utils::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 140 of file CObject.h.

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

◆ get()

CSerializablePtr CPropertiesValuesList::get ( const std::string & propertyName ) const

Returns the value of the property (case insensitive), or NULL if it does not exist.

Definition at line 146 of file CPropertiesValuesList.cpp.

References mrpt::system::os::_strcmpi(), and m_properties.

◆ getPropertyNames()

std::vector< std::string > CPropertiesValuesList::getPropertyNames ( ) const

Returns the name of all properties in the list.

Definition at line 199 of file CPropertiesValuesList.cpp.

References m_properties.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::utils::CPropertiesValuesList::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ operator delete() [1/3]

void mrpt::utils::CPropertiesValuesList::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator delete() [2/3]

void mrpt::utils::CPropertiesValuesList::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator delete() [3/3]

void mrpt::utils::CPropertiesValuesList::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator delete[]()

void mrpt::utils::CPropertiesValuesList::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator new() [1/3]

void* mrpt::utils::CPropertiesValuesList::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator new() [2/3]

void* mrpt::utils::CPropertiesValuesList::operator new ( size_t size )

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator new() [3/3]

static void* mrpt::utils::CPropertiesValuesList::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator new[]()

void* mrpt::utils::CPropertiesValuesList::operator new[] ( size_t size )

inline

Definition at line 29 of file CPropertiesValuesList.h.

◆ operator=()

CPropertiesValuesList & CPropertiesValuesList::operator= ( const CPropertiesValuesList & o )

Copy operator.

Definition at line 122 of file CPropertiesValuesList.cpp.

References m_properties.

◆ readFromStream()

void CPropertiesValuesList::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

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.

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

Implements mrpt::utils::CSerializable.

Definition at line 56 of file CPropertiesValuesList.cpp.

References mrpt::utils::clear(), MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and version.

◆ set()

void CPropertiesValuesList::set	(	const std::string &	propertyName,
		const CSerializablePtr &	obj
	)

Sets/change the value of the property (case insensitive), making a copy of the object (or setting it to NULL if it is the passed value)

Definition at line 161 of file CPropertiesValuesList.cpp.

References mrpt::system::os::_strcmpi(), m_properties, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::utils::CPropertiesValuesList::TPropertyValuePair::name, and mrpt::utils::CPropertiesValuesList::TPropertyValuePair::value.

◆ size()

size_t CPropertiesValuesList::size ( ) const

Returns the number of properties in the list.

Definition at line 191 of file CPropertiesValuesList.cpp.

References m_properties.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::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 NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

void CPropertiesValuesList::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

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.

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

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 28 of file CPropertiesValuesList.cpp.

Member Data Documentation

◆ _init_CPropertiesValuesList

mrpt::utils::CLASSINIT mrpt::utils::CPropertiesValuesList::_init_CPropertiesValuesList

staticprotected

Definition at line 29 of file CPropertiesValuesList.h.

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 128 of file CObject.h.

◆ classCPropertiesValuesList

mrpt::utils::TRuntimeClassId mrpt::utils::CPropertiesValuesList::classCPropertiesValuesList

static

Definition at line 29 of file CPropertiesValuesList.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::utils::CPropertiesValuesList::classinfo

static

Definition at line 29 of file CPropertiesValuesList.h.

◆ m_properties

std::vector<TPropertyValuePair> mrpt::utils::CPropertiesValuesList::m_properties

protected

The properties list: a map between strings and objects.

Definition at line 38 of file CPropertiesValuesList.h.

Referenced by clear(), CPropertiesValuesList(), get(), getPropertyNames(), operator=(), set(), and size().

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CPropertiesValuesList() [1/2]

◆ CPropertiesValuesList() [2/2]

◆ ~CPropertiesValuesList()

Member Function Documentation

◆ _GetBaseClass()

◆ clear()

◆ clone()

◆ Create()

◆ CreateObject()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ get()

◆ getPropertyNames()

◆ GetRuntimeClass()

◆ 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[]()

◆ operator=()

◆ readFromStream()

◆ set()

◆ size()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CPropertiesValuesList

◆ classCObject

◆ classCPropertiesValuesList

◆ classCSerializable

◆ classinfo

◆ m_properties