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 38 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) noexcept |
void | operator delete[] (void *ptr) noexcept |
void | operator delete (void *memory, void *ptr) noexcept |
void * | operator new (size_t size, const std::nothrow_t &) noexcept |
void | operator delete (void *ptr, const std::nothrow_t &) noexcept |
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... | |
CSerializable::Ptr | 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 nullptr 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 nullptr smart pointer if it does not exist. More... | |
CSerializable::Ptr | getAnyHypothesis (const char *propertyName) const |
Returns the value of the property (case insensitive) for the first hypothesis ID found, or nullptr if it does not exist. More... | |
void | set (const char *propertyName, const CSerializable::Ptr &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 nullptr if it is the passed value) More... | |
void | setMemoryReference (const char *propertyName, const CSerializable::Ptr &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... | |
RTTI classes and functions | |
mrpt::utils::CObject::Ptr | 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... | |
Static Public Member Functions | |
static void * | operator new (size_t size, void *ptr) |
Protected Member Functions | |
CSerializable virtual methods | |
void | writeToStream (mrpt::utils::CStream &out, int *getVersion) const override |
Introduces a pure virtual method responsible for writing to a CStream. More... | |
void | readFromStream (mrpt::utils::CStream &in, int version) override |
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 | |
using | Ptr = std::shared_ptr< CMHPropertiesValuesList > |
using | ConstPtr = std::shared_ptr< const CMHPropertiesValuesList > |
static mrpt::utils::CLASSINIT | _init_CMHPropertiesValuesList |
static const mrpt::utils::TRuntimeClassId | runtimeClassId |
static constexpr const char * | className = "CMHPropertiesValuesList" |
static const mrpt::utils::TRuntimeClassId * | _GetBaseClass () |
static const mrpt::utils::TRuntimeClassId & | GetRuntimeClassIdStatic () |
static mrpt::utils::CObject * | CreateObject () |
template<typename... Args> | |
static Ptr | Create (Args &&... args) |
virtual const mrpt::utils::TRuntimeClassId * | GetRuntimeClass () const override |
Returns information about the class of an object in runtime. More... | |
virtual mrpt::utils::CObject * | clone () const override |
Returns a deep copy (clone) of the object, indepently of its class. More... | |
typedef std::vector<TPropertyValueIDTriplet>::const_iterator mrpt::utils::CMHPropertiesValuesList::const_iterator |
Definition at line 204 of file CMHPropertiesValuesList.h.
using mrpt::utils::CMHPropertiesValuesList::ConstPtr = std::shared_ptr<const CMHPropertiesValuesList > |
Definition at line 40 of file CMHPropertiesValuesList.h.
typedef std::vector<TPropertyValueIDTriplet>::iterator mrpt::utils::CMHPropertiesValuesList::iterator |
Definition at line 203 of file CMHPropertiesValuesList.h.
using mrpt::utils::CMHPropertiesValuesList::Ptr = std::shared_ptr< CMHPropertiesValuesList > |
A typedef for the associated smart pointer
Definition at line 40 of file CMHPropertiesValuesList.h.
CMHPropertiesValuesList::CMHPropertiesValuesList | ( | ) |
Default constructor.
Definition at line 100 of file CMHPropertiesValuesList.cpp.
CMHPropertiesValuesList::CMHPropertiesValuesList | ( | const CMHPropertiesValuesList & | o | ) |
Copy constructor.
Definition at line 281 of file CMHPropertiesValuesList.cpp.
References m_properties.
|
virtual |
Destructor.
Definition at line 104 of file CMHPropertiesValuesList.cpp.
References mrpt::utils::clear().
|
staticprotected |
|
inline |
Definition at line 206 of file CMHPropertiesValuesList.h.
References m_properties.
|
inline |
Definition at line 207 of file CMHPropertiesValuesList.h.
References m_properties.
void CMHPropertiesValuesList::clear | ( | ) |
Clears the list and frees all object's memory.
Definition at line 108 of file CMHPropertiesValuesList.cpp.
References MRPT_END, and MRPT_START.
|
overridevirtual |
Returns a deep copy (clone) of the object, indepently of its class.
Implements mrpt::utils::CObject.
|
inlinestatic |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
static |
|
inline |
Definition at line 208 of file CMHPropertiesValuesList.h.
References m_properties.
|
inline |
Definition at line 209 of file CMHPropertiesValuesList.h.
References m_properties.
CSerializable::Ptr 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 nullptr smart pointer if it does not exist.
Definition at line 118 of file CMHPropertiesValuesList.cpp.
References mrpt::system::os::_strcmpi().
CSerializable::Ptr CMHPropertiesValuesList::getAnyHypothesis | ( | const char * | propertyName | ) | const |
Returns the value of the property (case insensitive) for the first hypothesis ID found, or nullptr if it does not exist.
Definition at line 138 of file CMHPropertiesValuesList.cpp.
References mrpt::system::os::_strcmpi().
|
inline |
Returns the value of the property (case insensitive) for some given hypothesis ID checking its class in runtime, or a nullptr smart pointer if it does not exist.
Definition at line 77 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 171 of file CMHPropertiesValuesList.h.
References ASSERT_, m_properties, 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 224 of file CMHPropertiesValuesList.cpp.
|
overridevirtual |
Returns information about the class of an object in runtime.
Reimplemented from mrpt::utils::CSerializable.
|
static |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
inlinenoexcept |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
inlinenoexcept |
Definition at line 40 of file CMHPropertiesValuesList.h.
Definition at line 40 of file CMHPropertiesValuesList.h.
|
inlinenoexcept |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
inlinestatic |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
inline |
Definition at line 40 of file CMHPropertiesValuesList.h.
CMHPropertiesValuesList & CMHPropertiesValuesList::operator= | ( | const CMHPropertiesValuesList & | o | ) |
|
overrideprotectedvirtual |
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.
Definition at line 56 of file CMHPropertiesValuesList.cpp.
References mrpt::utils::clear(), and MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.
Remove a given property, if it exists.
Definition at line 251 of file CMHPropertiesValuesList.cpp.
References mrpt::system::os::_strcmpi().
Remove all the properties for the given hypothesis.
Definition at line 267 of file CMHPropertiesValuesList.cpp.
void CMHPropertiesValuesList::set | ( | const char * | propertyName, |
const CSerializable::Ptr & | 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 nullptr if it is the passed value)
Definition at line 154 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.
|
inline |
Sets/change the value of a property (case insensitive) for the given hypothesis ID, from an elemental data type.
Definition at line 131 of file CMHPropertiesValuesList.h.
References mrpt::utils::TPropertyValueIDTriplet::ID, m_properties, 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 CSerializable::Ptr & | 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.
Definition at line 191 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.
|
inline |
Definition at line 210 of file CMHPropertiesValuesList.h.
References m_properties.
Referenced by writeToStream().
|
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 nullptr is class does not support conversion to MATLAB. Definition at line 89 of file CSerializable.h.
|
overrideprotectedvirtual |
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 nullptr, 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.
Definition at line 25 of file CMHPropertiesValuesList.cpp.
References size().
|
staticprotected |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
static |
Definition at line 40 of file CMHPropertiesValuesList.h.
|
private |
Definition at line 43 of file CMHPropertiesValuesList.h.
Referenced by begin(), CMHPropertiesValuesList(), end(), getElemental(), operator=(), setElemental(), and size().
|
staticprotected |
Definition at line 40 of file CMHPropertiesValuesList.h.
Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019 |