Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Types | Public Member Functions | 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 44 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

 CMHPropertiesValuesList ()
 Default constructor.
 
 CMHPropertiesValuesList (const CMHPropertiesValuesList &o)
 Copy constructor.
 
CMHPropertiesValuesListoperator= (const CMHPropertiesValuesList &o)
 Copy operator.
 
virtual ~CMHPropertiesValuesList ()
 Destructor.
 
void clear ()
 Clears the list and frees all object's memory.
 
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.
 
template<typename T >
T::SmartPtr 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.
 
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.
 
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)
 
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.
 
void remove (const char *propertyName, const int64_t &hypothesis_ID)
 Remove a given property, if it exists.
 
void removeAll (const int64_t &hypothesis_ID)
 Remove all the properties for the given hypothesis.
 
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.
 
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).
 
std::vector< std::string > getPropertyNames () const
 Returns the name of all properties in the list.
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
size_t size () const
 

Protected Member Functions

CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE
 
void readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE
 

Private Attributes

std::vector< TPropertyValueIDTripletm_properties
 

RTTI stuff <br>

typedef CMHPropertiesValuesListPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CMHPropertiesValuesList
 
static mrpt::utils::TRuntimeClassId classCMHPropertiesValuesList
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static CMHPropertiesValuesListPtr Create ()
 

Member Typedef Documentation

◆ const_iterator

Definition at line 184 of file CMHPropertiesValuesList.h.

◆ iterator

Definition at line 183 of file CMHPropertiesValuesList.h.

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 47 of file CMHPropertiesValuesList.h.

Constructor & Destructor Documentation

◆ CMHPropertiesValuesList() [1/2]

mrpt::utils::CMHPropertiesValuesList::CMHPropertiesValuesList ( )

Default constructor.

◆ CMHPropertiesValuesList() [2/2]

mrpt::utils::CMHPropertiesValuesList::CMHPropertiesValuesList ( const CMHPropertiesValuesList o)

Copy constructor.

◆ ~CMHPropertiesValuesList()

virtual mrpt::utils::CMHPropertiesValuesList::~CMHPropertiesValuesList ( )
virtual

Destructor.

Member Function Documentation

◆ _GetBaseClass()

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

◆ begin() [1/2]

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

Definition at line 186 of file CMHPropertiesValuesList.h.

◆ begin() [2/2]

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

Definition at line 187 of file CMHPropertiesValuesList.h.

◆ clear()

void mrpt::utils::CMHPropertiesValuesList::clear ( )

Clears the list and frees all object's memory.

◆ Create()

static CMHPropertiesValuesListPtr mrpt::utils::CMHPropertiesValuesList::Create ( )
static

◆ CreateObject()

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

◆ duplicate()

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

◆ end() [1/2]

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

Definition at line 188 of file CMHPropertiesValuesList.h.

◆ end() [2/2]

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

Definition at line 189 of file CMHPropertiesValuesList.h.

◆ get()

CSerializablePtr mrpt::utils::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.

◆ getAnyHypothesis()

CSerializablePtr mrpt::utils::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.

◆ getAs()

template<typename T >
T::SmartPtr 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 80 of file CMHPropertiesValuesList.h.

References ASSERT_, MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ getElemental()

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 157 of file CMHPropertiesValuesList.h.

References ASSERT_, mrpt::utils::CMemoryChunkPtr, MRPT_END, MRPT_START, mrpt::system::strCmpI(), THROW_EXCEPTION, and THROW_EXCEPTION_CUSTOM_MSG1.

◆ getPropertyNames()

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

Returns the name of all properties in the list.

◆ GetRuntimeClass()

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

◆ operator=()

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

Copy operator.

◆ readFromStream()

void mrpt::utils::CMHPropertiesValuesList::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protected

◆ remove()

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

Remove a given property, if it exists.

◆ removeAll()

void mrpt::utils::CMHPropertiesValuesList::removeAll ( const int64_t &  hypothesis_ID)

Remove all the properties for the given hypothesis.

◆ set()

void mrpt::utils::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

◆ setElemental()

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 122 of file CMHPropertiesValuesList.h.

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

◆ setMemoryReference()

void mrpt::utils::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

◆ size()

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

Definition at line 191 of file CMHPropertiesValuesList.h.

◆ writeToStream()

void mrpt::utils::CMHPropertiesValuesList::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protected

Member Data Documentation

◆ _init_CMHPropertiesValuesList

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

Definition at line 47 of file CMHPropertiesValuesList.h.

◆ classCMHPropertiesValuesList

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

Definition at line 47 of file CMHPropertiesValuesList.h.

◆ classinfo

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

Definition at line 47 of file CMHPropertiesValuesList.h.

◆ m_properties

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

Definition at line 50 of file CMHPropertiesValuesList.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Thu Mar 23 03:22:58 UTC 2023