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 | |
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 () |
CMHPropertiesValuesList () | |
Default constructor. More... | |
CMHPropertiesValuesList (const CMHPropertiesValuesList &o) | |
Copy constructor. More... | |
CMHPropertiesValuesList & | operator= (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::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. 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::string > | getPropertyNames () 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 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... | |
Private Attributes | |
std::vector< TPropertyValueIDTriplet > | m_properties |
RTTI stuff | |
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 |
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 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.
typedef CMHPropertiesValuesListPtr mrpt::utils::CMHPropertiesValuesList::SmartPtr |
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.
|
inlineinherited |
|
static |
|
static |
|
virtual |
Returns a copy of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlineinherited |
|
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::utils::CSerializablePtr, 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_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 |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inlinestatic |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 47 of file CMHPropertiesValuesList.h.
CMHPropertiesValuesList& mrpt::utils::CMHPropertiesValuesList::operator= | ( | const CMHPropertiesValuesList & | o | ) |
Copy operator.
|
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.
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. |
std::exception | On any error, see CStream::ReadBuffer |
Implements mrpt::utils::CSerializable.
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::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.
References DEFINE_SERIALIZABLE_POST_CUSTOM_BASE.
|
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.
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.
References BASE_IMPEXP, mrpt::utils::CSerializablePtr, DEFINE_MRPT_OBJECT_POST, mrpt::utils::ObjectToOctetVector(), mrpt::utils::ObjectToRawString(), mrpt::utils::ObjectToString(), mrpt::utils::OctetVectorToObject(), mrpt::utils::RawStringToObject(), and mrpt::utils::StringToObject().
|
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.
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. |
std::exception | On any error, see CStream::WriteBuffer |
Implements mrpt::utils::CSerializable.
|
staticprotected |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
static |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
staticinherited |
|
staticinherited |
Definition at line 42 of file CSerializable.h.
|
static |
Definition at line 47 of file CMHPropertiesValuesList.h.
|
private |
Definition at line 50 of file CMHPropertiesValuesList.h.
Page generated by Doxygen 1.8.12 for MRPT 1.3.2 SVN: at Thu Nov 10 13:46:27 UTC 2016 |