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

#include <mrpt/utils/CPropertiesValuesList.h>

Inheritance diagram for mrpt::utils::CPropertiesValuesList:

Classes
struct	TPropertyValuePair
Public Member Functions
	CPropertiesValuesList ()
	Default constructor.
	CPropertiesValuesList (const CPropertiesValuesList &o)
	Copy constructor.
CPropertiesValuesList &	operator= (const CPropertiesValuesList &o)
	Copy operator.
virtual	~CPropertiesValuesList ()
	Destructor.
void	clear ()
	Clears the list.
CSerializablePtr	get (const std::string &propertyName) const
	Returns the value of the property (case insensitive), or NULL if it does not exist.
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)
size_t	size () const
	Returns the number of properties in the list.
std::vector< std::string >	getPropertyNames () const
	Returns the name of all properties in the list.
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.
Protected Attributes
std::vector< TPropertyValuePair >	m_properties
	The properties list: a map between strings and objects.
RTTI stuff
typedef CPropertiesValuesListPtr	SmartPtr
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.
virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.
static mrpt::utils::CObject *	CreateObject ()
static CPropertiesValuesListPtr	Create ()
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable
class	mrpt::utils::CStream

Member Typedef Documentation

typedef CPropertiesValuesListPtr mrpt::utils::CPropertiesValuesList::SmartPtr

A typedef for the associated smart pointer

Definition at line 51 of file CPropertiesValuesList.h.

Constructor & Destructor Documentation

mrpt::utils::CPropertiesValuesList::CPropertiesValuesList ( )

Default constructor.

mrpt::utils::CPropertiesValuesList::CPropertiesValuesList ( const CPropertiesValuesList & o )

Copy constructor.

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

Destructor.

Member Function Documentation

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

Reimplemented from mrpt::utils::CSerializable.

void mrpt::utils::CPropertiesValuesList::clear ( )

Clears the list.

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 CPropertiesValuesListPtr mrpt::utils::CPropertiesValuesList::Create ( ) [static]

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

virtual mrpt::utils::CObject* mrpt::utils::CPropertiesValuesList::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.

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

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

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

Returns the name of all properties in the list.

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.

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

Copy operator.

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

size_t mrpt::utils::CPropertiesValuesList::size ( ) const

Returns the number of properties in the list.

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