MRPT  1.9.9
mrpt::hmtslam::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 35 of file CMHPropertiesValuesList.h.

#include <mrpt/hmtslam/CMHPropertiesValuesList.h>

Inheritance diagram for mrpt::hmtslam::CMHPropertiesValuesList:

Public Types

using iterator = std::vector< TPropertyValueIDTriplet >::iterator
 
using const_iterator = std::vector< TPropertyValueIDTriplet >::const_iterator
 

Public Member Functions

 CMHPropertiesValuesList ()
 Default constructor. More...
 
 CMHPropertiesValuesList (const CMHPropertiesValuesList &o)
 Copy constructor. More...
 
CMHPropertiesValuesListoperator= (const CMHPropertiesValuesList &o)
 Copy operator. More...
 
 ~CMHPropertiesValuesList () override
 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::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...
 
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr duplicateGetSmartPtr () const
 Makes a deep copy of the object and returns a smart pointer to it. More...
 

Protected Member Functions

CSerializable virtual methods
uint8_t serializeGetVersion () const override
 Must return the current versioning number of the object. More...
 
void serializeTo (mrpt::serialization::CArchive &out) const override
 Pure virtual method for writing (serializing) to an abstract archive. More...
 
void serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
 Pure virtual method for reading (deserializing) from an abstract archive. More...
 
CSerializable virtual methods
virtual void serializeTo (CSchemeArchiveBase &out) const
 Virtual method for writing (serializing) to an abstract schema based archive. More...
 
virtual void serializeFrom (CSchemeArchiveBase &in)
 Virtual method for reading (deserializing) from an abstract schema based archive. More...
 

Private Attributes

std::vector< TPropertyValueIDTripletm_properties
 

RTTI stuff

using Ptr = std::shared_ptr< CMHPropertiesValuesList >
 
using ConstPtr = std::shared_ptr< const CMHPropertiesValuesList >
 
using UniquePtr = std::unique_ptr< CMHPropertiesValuesList >
 
using ConstUniquePtr = std::unique_ptr< const CMHPropertiesValuesList >
 
static mrpt::rtti::CLASSINIT _init_CMHPropertiesValuesList
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CMHPropertiesValuesList"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static std::shared_ptr< CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename Alloc , typename... Args>
static Ptr CreateAlloc (const Alloc &alloc, Args &&... args)
 
template<typename... Args>
static UniquePtr CreateUnique (Args &&... args)
 
virtual const mrpt::rtti::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::rtti::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ const_iterator

◆ ConstPtr

◆ ConstUniquePtr

◆ iterator

◆ Ptr

A type for the associated smart pointer

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ UniquePtr

Constructor & Destructor Documentation

◆ CMHPropertiesValuesList() [1/2]

CMHPropertiesValuesList::CMHPropertiesValuesList ( )
default

Default constructor.

◆ CMHPropertiesValuesList() [2/2]

CMHPropertiesValuesList::CMHPropertiesValuesList ( const CMHPropertiesValuesList o)

Copy constructor.

Definition at line 258 of file CMHPropertiesValuesList.cpp.

References m_properties.

◆ ~CMHPropertiesValuesList()

CMHPropertiesValuesList::~CMHPropertiesValuesList ( )
override

Destructor.

Definition at line 93 of file CMHPropertiesValuesList.cpp.

References mrpt::containers::clear().

Here is the call graph for this function:

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::hmtslam::CMHPropertiesValuesList::_GetBaseClass ( )
staticprotected

◆ begin() [1/2]

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

Definition at line 198 of file CMHPropertiesValuesList.h.

References m_properties.

◆ begin() [2/2]

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

Definition at line 199 of file CMHPropertiesValuesList.h.

References m_properties.

◆ clear()

void CMHPropertiesValuesList::clear ( )

Clears the list and frees all object's memory.

Definition at line 97 of file CMHPropertiesValuesList.cpp.

References MRPT_END, and MRPT_START.

◆ clone()

virtual mrpt::rtti::CObject* mrpt::hmtslam::CMHPropertiesValuesList::clone ( ) const
overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::rtti::CObject.

◆ Create()

template<typename... Args>
static Ptr mrpt::hmtslam::CMHPropertiesValuesList::Create ( Args &&...  args)
inlinestatic

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ CreateAlloc()

template<typename Alloc , typename... Args>
static Ptr mrpt::hmtslam::CMHPropertiesValuesList::CreateAlloc ( const Alloc &  alloc,
Args &&...  args 
)
inlinestatic

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::hmtslam::CMHPropertiesValuesList::CreateObject ( )
static

◆ CreateUnique()

template<typename... Args>
static UniquePtr mrpt::hmtslam::CMHPropertiesValuesList::CreateUnique ( Args &&...  args)
inlinestatic

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const
inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 200 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ end() [1/2]

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

Definition at line 200 of file CMHPropertiesValuesList.h.

References m_properties.

◆ end() [2/2]

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

Definition at line 201 of file CMHPropertiesValuesList.h.

References m_properties.

◆ get()

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 107 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ getAnyHypothesis()

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 127 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ getAs()

template<typename T >
T::Ptr mrpt::hmtslam::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 nullptr smart pointer if it does not exist.

Definition at line 74 of file CMHPropertiesValuesList.h.

References ASSERT_, MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ getClassName()

static constexpr auto mrpt::hmtslam::CMHPropertiesValuesList::getClassName ( )
inlinestatic

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ getElemental()

template<class T >
bool mrpt::hmtslam::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 167 of file CMHPropertiesValuesList.h.

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

Here is the call graph for this function:

◆ getPropertyNames()

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

Returns the name of all properties in the list.

Definition at line 208 of file CMHPropertiesValuesList.cpp.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::hmtslam::CMHPropertiesValuesList::GetRuntimeClass ( ) const
overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::hmtslam::CMHPropertiesValuesList::GetRuntimeClassIdStatic ( )
static

◆ operator=()

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

Copy operator.

Definition at line 270 of file CMHPropertiesValuesList.cpp.

References m_properties.

◆ remove()

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

Remove a given property, if it exists.

Definition at line 232 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ removeAll()

void CMHPropertiesValuesList::removeAll ( const int64_t hypothesis_ID)

Remove all the properties for the given hypothesis.

Definition at line 246 of file CMHPropertiesValuesList.cpp.

◆ serializeFrom() [1/2]

void CMHPropertiesValuesList::serializeFrom ( mrpt::serialization::CArchive in,
uint8_t  serial_version 
)
overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 47 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ serializeFrom() [2/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase in)
inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeGetVersion()

uint8_t CMHPropertiesValuesList::serializeGetVersion ( ) const
overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 23 of file CMHPropertiesValuesList.cpp.

◆ serializeTo() [1/2]

void CMHPropertiesValuesList::serializeTo ( mrpt::serialization::CArchive out) const
overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions
std::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 24 of file CMHPropertiesValuesList.cpp.

◆ serializeTo() [2/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase out) const
inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ set()

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)

See also
setMemoryReference

Definition at line 142 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ setElemental()

template<class T >
void mrpt::hmtslam::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 129 of file CMHPropertiesValuesList.h.

References mrpt::hmtslam::TPropertyValueIDTriplet::basic_value, mrpt::hmtslam::TPropertyValueIDTriplet::ID, m_properties, mrpt::system::os::memcpy(), MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::hmtslam::TPropertyValueIDTriplet::name, and mrpt::system::strCmpI().

Here is the call graph for this function:

◆ setMemoryReference()

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.

See also
set

Definition at line 177 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ size()

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

Definition at line 202 of file CMHPropertiesValuesList.h.

References m_properties.

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::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 nullptr is class does not support conversion to MATLAB.

Definition at line 90 of file CSerializable.h.

Member Data Documentation

◆ _init_CMHPropertiesValuesList

mrpt::rtti::CLASSINIT mrpt::hmtslam::CMHPropertiesValuesList::_init_CMHPropertiesValuesList
staticprotected

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ className

constexpr const char* mrpt::hmtslam::CMHPropertiesValuesList::className = "CMHPropertiesValuesList"
static

Definition at line 37 of file CMHPropertiesValuesList.h.

◆ m_properties

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

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::hmtslam::CMHPropertiesValuesList::runtimeClassId
staticprotected

Definition at line 37 of file CMHPropertiesValuesList.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: c26d46ba6 Thu Jul 18 13:03:42 2019 +0200 at jue jul 18 13:10:17 CEST 2019