Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
mrpt::utils::CMHPropertiesValuesList Class Reference

Detailed Description

An arbitrary list of "annotations", or named attributes, each being an instance of any CSerializable object (Multi-hypotheses version).

For each named annotation (or attribute), several values may exist, each associated to a given hypothesis ID. A non multi-hypotheses version exists in CPropertiesValuesList.

See Also
CSerializable, CPropertiesValuesList

Definition at line 41 of file CMHPropertiesValuesList.h.

#include <mrpt/utils/CMHPropertiesValuesList.h>

Inheritance diagram for mrpt::utils::CMHPropertiesValuesList:
Inheritance graph

Public Types

typedef std::vector
< TPropertyValueIDTriplet >
::iterator 
iterator
 
typedef std::vector
< TPropertyValueIDTriplet >
::const_iterator 
const_iterator
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) throw ()
 
void operator delete[] (void *ptr) throw ()
 
void operator delete (void *memory, void *ptr) throw ()
 
voidoperator new (size_t size, const std::nothrow_t &) throw ()
 
void operator delete (void *ptr, const std::nothrow_t &) throw ()
 
 CMHPropertiesValuesList ()
 Default constructor. More...
 
 CMHPropertiesValuesList (const CMHPropertiesValuesList &o)
 Copy constructor. More...
 
CMHPropertiesValuesListoperator= (const CMHPropertiesValuesList &o)
 Copy operator. More...
 
virtual ~CMHPropertiesValuesList ()
 Destructor. More...
 
void clear ()
 Clears the list and frees all object's memory. More...
 
CSerializablePtr get (const char *propertyName, const int64_t &hypothesis_ID) const
 Returns the value of the property (case insensitive) for some given hypothesis ID, or a NULL smart pointer if it does not exist. More...
 
template<typename T >
T::Ptr getAs (const char *propertyName, const int64_t &hypothesis_ID, bool allowNullPointer=true) const
 Returns the value of the property (case insensitive) for some given hypothesis ID checking its class in runtime, or a NULL smart pointer if it does not exist. More...
 
CSerializablePtr getAnyHypothesis (const char *propertyName) const
 Returns the value of the property (case insensitive) for the first hypothesis ID found, or NULL if it does not exist. More...
 
void set (const char *propertyName, const CSerializablePtr &obj, const int64_t &hypothesis_ID)
 Sets/change the value of the property (case insensitive) for the given hypothesis ID, making a copy of the object (or setting it to NULL if it is the passed value) More...
 
void setMemoryReference (const char *propertyName, const CSerializablePtr &obj, const int64_t &hypothesis_ID)
 Sets/change the value of the property (case insensitive) for the given hypothesis ID, directly replacing the pointer instead of making a copy of the object. More...
 
void remove (const char *propertyName, const int64_t &hypothesis_ID)
 Remove a given property, if it exists. More...
 
void removeAll (const int64_t &hypothesis_ID)
 Remove all the properties for the given hypothesis. More...
 
template<class T >
void setElemental (const char *propertyName, const T &data, const int64_t &hypothesis_ID)
 Sets/change the value of a property (case insensitive) for the given hypothesis ID, from an elemental data type. More...
 
template<class T >
bool getElemental (const char *propertyName, T &out_data, const int64_t &hypothesis_ID, bool raiseExceptionIfNotFound=false) const
 Gets the value of a property (case insensitive) for the given hypothesis ID, retrieves it as an elemental data type (types must coincide, basic size check is performed). More...
 
std::vector< std::stringgetPropertyNames () const
 Returns the name of all properties in the list. More...
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
size_t size () const
 
virtual mxArraywriteToMatlab () 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...
 
CObjectclone () const
 Cloning interface for smart pointers. More...
 

Static Public Member Functions

static voidoperator 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...
 

Private Attributes

std::vector
< TPropertyValueIDTriplet
m_properties
 

RTTI stuff

typedef CMHPropertiesValuesListPtr Ptr
 
typedef CMHPropertiesValuesListPtr ConstPtr
 
static mrpt::utils::CLASSINIT _init_CMHPropertiesValuesList
 
static mrpt::utils::TRuntimeClassId classCMHPropertiesValuesList
 
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::CObjectduplicate () const
 Returns a copy of the object, indepently of its class. More...
 
static mrpt::utils::CObjectCreateObject ()
 
static CMHPropertiesValuesListPtr Create ()
 

Member Typedef Documentation

Definition at line 181 of file CMHPropertiesValuesList.h.

typedef CMHPropertiesValuesListPtr mrpt::utils::CMHPropertiesValuesList::ConstPtr

Definition at line 44 of file CMHPropertiesValuesList.h.

Definition at line 180 of file CMHPropertiesValuesList.h.

typedef CMHPropertiesValuesListPtr mrpt::utils::CMHPropertiesValuesList::Ptr

A typedef for the associated smart pointer

Definition at line 44 of file CMHPropertiesValuesList.h.

Constructor & Destructor Documentation

CMHPropertiesValuesList::CMHPropertiesValuesList ( )

Default constructor.

Definition at line 104 of file CMHPropertiesValuesList.cpp.

CMHPropertiesValuesList::CMHPropertiesValuesList ( const CMHPropertiesValuesList o)

Copy constructor.

Definition at line 286 of file CMHPropertiesValuesList.cpp.

References m_properties.

CMHPropertiesValuesList::~CMHPropertiesValuesList ( )
virtual

Destructor.

Definition at line 112 of file CMHPropertiesValuesList.cpp.

References mrpt::utils::clear().

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CMHPropertiesValuesList::_GetBaseClass ( )
staticprotected
iterator mrpt::utils::CMHPropertiesValuesList::begin ( )
inline

Definition at line 183 of file CMHPropertiesValuesList.h.

const_iterator mrpt::utils::CMHPropertiesValuesList::begin ( ) const
inline

Definition at line 184 of file CMHPropertiesValuesList.h.

void CMHPropertiesValuesList::clear ( )

Clears the list and frees all object's memory.

Definition at line 120 of file CMHPropertiesValuesList.cpp.

References MRPT_END, and MRPT_START.

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

Cloning interface for smart pointers.

Definition at line 143 of file CObject.h.

static CMHPropertiesValuesListPtr mrpt::utils::CMHPropertiesValuesList::Create ( )
static
static mrpt::utils::CObject* mrpt::utils::CMHPropertiesValuesList::CreateObject ( )
static
virtual mrpt::utils::CObject* mrpt::utils::CMHPropertiesValuesList::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
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().

iterator mrpt::utils::CMHPropertiesValuesList::end ( )
inline

Definition at line 185 of file CMHPropertiesValuesList.h.

const_iterator mrpt::utils::CMHPropertiesValuesList::end ( ) const
inline

Definition at line 186 of file CMHPropertiesValuesList.h.

CSerializablePtr CMHPropertiesValuesList::get ( const char *  propertyName,
const int64_t hypothesis_ID 
) const

Returns the value of the property (case insensitive) for some given hypothesis ID, or a NULL smart pointer if it does not exist.

Definition at line 130 of file CMHPropertiesValuesList.cpp.

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

CSerializablePtr CMHPropertiesValuesList::getAnyHypothesis ( const char *  propertyName) const

Returns the value of the property (case insensitive) for the first hypothesis ID found, or NULL if it does not exist.

Definition at line 150 of file CMHPropertiesValuesList.cpp.

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

template<typename T >
T::Ptr mrpt::utils::CMHPropertiesValuesList::getAs ( const char *  propertyName,
const int64_t hypothesis_ID,
bool  allowNullPointer = true 
) const
inline

Returns the value of the property (case insensitive) for some given hypothesis ID checking its class in runtime, or a NULL smart pointer if it does not exist.

Definition at line 77 of file CMHPropertiesValuesList.h.

References ASSERT_, MRPT_END, MRPT_START, and THROW_EXCEPTION.

template<class T >
bool mrpt::utils::CMHPropertiesValuesList::getElemental ( const char *  propertyName,
T &  out_data,
const int64_t hypothesis_ID,
bool  raiseExceptionIfNotFound = false 
) const
inline

Gets the value of a property (case insensitive) for the given hypothesis ID, retrieves it as an elemental data type (types must coincide, basic size check is performed).

Returns
false if the property does not exist for the given hypothesis.

Definition at line 154 of file CMHPropertiesValuesList.h.

References ASSERT_, MRPT_END, MRPT_START, mrpt::system::strCmpI(), THROW_EXCEPTION, and THROW_EXCEPTION_FMT.

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

Returns the name of all properties in the list.

Definition at line 235 of file CMHPropertiesValuesList.cpp.

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

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

void mrpt::utils::CMHPropertiesValuesList::operator delete ( void ptr)
throw (
)
inline

Definition at line 44 of file CMHPropertiesValuesList.h.

void mrpt::utils::CMHPropertiesValuesList::operator delete ( void memory,
void ptr 
)
throw (
)
inline

Definition at line 44 of file CMHPropertiesValuesList.h.

void mrpt::utils::CMHPropertiesValuesList::operator delete ( void ptr,
const std::nothrow_t &   
)
throw (
)
inline

Definition at line 44 of file CMHPropertiesValuesList.h.

void mrpt::utils::CMHPropertiesValuesList::operator delete[] ( void ptr)
throw (
)
inline

Definition at line 44 of file CMHPropertiesValuesList.h.

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

Definition at line 44 of file CMHPropertiesValuesList.h.

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

Definition at line 44 of file CMHPropertiesValuesList.h.

void* mrpt::utils::CMHPropertiesValuesList::operator new ( size_t  size)
inline

Definition at line 44 of file CMHPropertiesValuesList.h.

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

Definition at line 44 of file CMHPropertiesValuesList.h.

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

Copy operator.

Definition at line 296 of file CMHPropertiesValuesList.cpp.

References m_properties.

void CMHPropertiesValuesList::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
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn any error, see CStream::ReadBuffer
See Also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 59 of file CMHPropertiesValuesList.cpp.

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

void CMHPropertiesValuesList::remove ( const char *  propertyName,
const int64_t hypothesis_ID 
)

Remove a given property, if it exists.

Definition at line 260 of file CMHPropertiesValuesList.cpp.

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

void CMHPropertiesValuesList::removeAll ( const int64_t hypothesis_ID)

Remove all the properties for the given hypothesis.

Definition at line 273 of file CMHPropertiesValuesList.cpp.

void CMHPropertiesValuesList::set ( const char *  propertyName,
const CSerializablePtr &  obj,
const int64_t hypothesis_ID 
)

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

See Also
setMemoryReference

Definition at line 164 of file CMHPropertiesValuesList.cpp.

References mrpt::system::os::_strcmpi(), mrpt::utils::TPropertyValueIDTriplet::ID, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::utils::TPropertyValueIDTriplet::name, and mrpt::utils::TPropertyValueIDTriplet::value.

template<class T >
void mrpt::utils::CMHPropertiesValuesList::setElemental ( const char *  propertyName,
const T &  data,
const int64_t hypothesis_ID 
)
inline

Sets/change the value of a property (case insensitive) for the given hypothesis ID, from an elemental data type.

Definition at line 119 of file CMHPropertiesValuesList.h.

References mrpt::utils::TPropertyValueIDTriplet::ID, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::utils::TPropertyValueIDTriplet::name, mrpt::system::strCmpI(), and mrpt::utils::TPropertyValueIDTriplet::value.

void CMHPropertiesValuesList::setMemoryReference ( const char *  propertyName,
const CSerializablePtr &  obj,
const int64_t hypothesis_ID 
)

Sets/change the value of the property (case insensitive) for the given hypothesis ID, directly replacing the pointer instead of making a copy of the object.

See Also
set

Definition at line 201 of file CMHPropertiesValuesList.cpp.

References mrpt::system::os::_strcmpi(), mrpt::utils::TPropertyValueIDTriplet::ID, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::utils::TPropertyValueIDTriplet::name, and mrpt::utils::TPropertyValueIDTriplet::value.

size_t mrpt::utils::CMHPropertiesValuesList::size ( ) const
inline

Definition at line 188 of file CMHPropertiesValuesList.h.

Referenced by writeToStream().

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.

void CMHPropertiesValuesList::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
outThe output binary stream where object must be dumped.
getVersionIf 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::exceptionOn any error, see CStream::WriteBuffer
See Also
CStream

Implements mrpt::utils::CSerializable.

Definition at line 26 of file CMHPropertiesValuesList.cpp.

References size().

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::utils::CMHPropertiesValuesList::_init_CMHPropertiesValuesList
staticprotected

Definition at line 44 of file CMHPropertiesValuesList.h.

mrpt::utils::TRuntimeClassId mrpt::utils::CMHPropertiesValuesList::classCMHPropertiesValuesList
static

Definition at line 44 of file CMHPropertiesValuesList.h.

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

Definition at line 128 of file CObject.h.

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

Definition at line 42 of file CSerializable.h.

const mrpt::utils::TRuntimeClassId* mrpt::utils::CMHPropertiesValuesList::classinfo
static

Definition at line 44 of file CMHPropertiesValuesList.h.

std::vector<TPropertyValueIDTriplet> mrpt::utils::CMHPropertiesValuesList::m_properties
private

Definition at line 47 of file CMHPropertiesValuesList.h.

Referenced by CMHPropertiesValuesList(), and operator=().




Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018