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.
Definition at line 44 of file CMHPropertiesValuesList.h.
#include <mrpt/utils/CMHPropertiesValuesList.h>
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. | |
CMHPropertiesValuesList & | operator= (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< TPropertyValueIDTriplet > | m_properties |
RTTI stuff <br> | |
typedef CMHPropertiesValuesListPtr | SmartPtr |
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 MRPT_OVERRIDE |
virtual mrpt::utils::CObject * | duplicate () const MRPT_OVERRIDE |
static mrpt::utils::CObject * | CreateObject () |
static CMHPropertiesValuesListPtr | Create () |
typedef std::vector<TPropertyValueIDTriplet>::const_iterator mrpt::utils::CMHPropertiesValuesList::const_iterator |
Definition at line 184 of file CMHPropertiesValuesList.h.
typedef std::vector<TPropertyValueIDTriplet>::iterator mrpt::utils::CMHPropertiesValuesList::iterator |
Definition at line 183 of file CMHPropertiesValuesList.h.
A typedef for the associated smart pointer
Definition at line 47 of file CMHPropertiesValuesList.h.
mrpt::utils::CMHPropertiesValuesList::CMHPropertiesValuesList | ( | ) |
Default constructor.
mrpt::utils::CMHPropertiesValuesList::CMHPropertiesValuesList | ( | const CMHPropertiesValuesList & | o | ) |
Copy constructor.
|
virtual |
Destructor.
|
staticprotected |
|
inline |
Definition at line 186 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 187 of file CMHPropertiesValuesList.h.
void mrpt::utils::CMHPropertiesValuesList::clear | ( | ) |
Clears the list and frees all object's memory.
|
static |
|
static |
|
virtual |
|
inline |
Definition at line 188 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 189 of file CMHPropertiesValuesList.h.
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.
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.
|
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.
|
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).
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.
std::vector< std::string > mrpt::utils::CMHPropertiesValuesList::getPropertyNames | ( | ) | const |
Returns the name of all properties in the list.
|
virtual |
CMHPropertiesValuesList & mrpt::utils::CMHPropertiesValuesList::operator= | ( | const CMHPropertiesValuesList & | o | ) |
Copy operator.
|
protected |
void mrpt::utils::CMHPropertiesValuesList::remove | ( | const char * | propertyName, |
const int64_t & | hypothesis_ID | ||
) |
Remove a given property, if it exists.
void mrpt::utils::CMHPropertiesValuesList::removeAll | ( | const int64_t & | hypothesis_ID | ) |
Remove all the properties for the given hypothesis.
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)
|
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.
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.
|
inline |
Definition at line 191 of file CMHPropertiesValuesList.h.
|
protected |
|
staticprotected |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
static |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
static |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
private |
Definition at line 50 of file CMHPropertiesValuesList.h.
Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Thu Dec 14 17:13:25 UTC 2023 |