Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Attributes
mrpt::hmtslam::CPropertiesValuesList Class Reference

Detailed Description

An arbitrary list of "annotations", or named attributes, each being an instance of any CSerializable object.

A multi-hypotheses version exists in CMHPropertiesValuesList.

See also
CSerializable, CMHPropertiesValuesList, mrpt::system::TParameters

Definition at line 24 of file CPropertiesValuesList.h.

#include <mrpt/hmtslam/CPropertiesValuesList.h>

Inheritance diagram for mrpt::hmtslam::CPropertiesValuesList:
Inheritance graph

Classes

struct  TPropertyValuePair
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
 CPropertiesValuesList ()
 Default constructor. More...
 
 CPropertiesValuesList (const CPropertiesValuesList &o)
 Copy constructor. More...
 
CPropertiesValuesListoperator= (const CPropertiesValuesList &o)
 Copy operator. More...
 
virtual ~CPropertiesValuesList ()
 Destructor. More...
 
void clear ()
 Clears the list. More...
 
CSerializable::Ptr get (const std::string &propertyName) const
 Returns the value of the property (case insensitive), or nullptr if it does not exist. More...
 
void set (const std::string &propertyName, const CSerializable::Ptr &obj)
 Sets/change the value of the property (case insensitive), making a copy of the object (or setting it to nullptr if it is the passed value) More...
 
size_t size () const
 Returns the number of properties in the list. More...
 
std::vector< std::stringgetPropertyNames () const
 Returns the name of all properties in the list. More...
 
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
 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 voidoperator new (size_t size, void *ptr)
 

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...
 

Protected Attributes

std::vector< TPropertyValuePairm_properties
 The properties list: a map between strings and objects. More...
 

RTTI stuff

using Ptr = std::shared_ptr< CPropertiesValuesList >
 
using ConstPtr = std::shared_ptr< const CPropertiesValuesList >
 
using UniquePtr = std::unique_ptr< CPropertiesValuesList >
 
using ConstUniquePtr = std::unique_ptr< const CPropertiesValuesList >
 
static mrpt::rtti::CLASSINIT _init_CPropertiesValuesList
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CPropertiesValuesList"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::rtti::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (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

◆ ConstPtr

Definition at line 26 of file CPropertiesValuesList.h.

◆ ConstUniquePtr

Definition at line 26 of file CPropertiesValuesList.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 26 of file CPropertiesValuesList.h.

◆ UniquePtr

Definition at line 26 of file CPropertiesValuesList.h.

Constructor & Destructor Documentation

◆ CPropertiesValuesList() [1/2]

CPropertiesValuesList::CPropertiesValuesList ( )

Default constructor.

Definition at line 88 of file CPropertiesValuesList.cpp.

◆ CPropertiesValuesList() [2/2]

CPropertiesValuesList::CPropertiesValuesList ( const CPropertiesValuesList o)

Copy constructor.

Definition at line 96 of file CPropertiesValuesList.cpp.

References m_properties.

◆ ~CPropertiesValuesList()

CPropertiesValuesList::~CPropertiesValuesList ( )
virtual

Destructor.

Definition at line 92 of file CPropertiesValuesList.cpp.

References mrpt::containers::clear().

Member Function Documentation

◆ _GetBaseClass()

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

◆ clear()

void CPropertiesValuesList::clear ( )

Clears the list.

Definition at line 122 of file CPropertiesValuesList.cpp.

References m_properties, MRPT_END, and MRPT_START.

◆ clone()

virtual mrpt::rtti::CObject* mrpt::hmtslam::CPropertiesValuesList::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::CPropertiesValuesList::Create ( Args &&...  args)
inlinestatic

Definition at line 26 of file CPropertiesValuesList.h.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::hmtslam::CPropertiesValuesList::CreateObject ( )
static

◆ CreateUnique()

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

Definition at line 26 of file CPropertiesValuesList.h.

◆ duplicateGetSmartPtr()

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

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).

Definition at line 169 of file CObject.h.

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

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

◆ get()

CSerializable::Ptr CPropertiesValuesList::get ( const std::string propertyName) const

Returns the value of the property (case insensitive), or nullptr if it does not exist.

Definition at line 132 of file CPropertiesValuesList.cpp.

References mrpt::system::os::_strcmpi(), and m_properties.

◆ getClassName()

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

Definition at line 26 of file CPropertiesValuesList.h.

◆ getPropertyNames()

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

Returns the name of all properties in the list.

Definition at line 187 of file CPropertiesValuesList.cpp.

References m_properties.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::hmtslam::CPropertiesValuesList::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::CPropertiesValuesList::GetRuntimeClassIdStatic ( )
static

◆ operator delete() [1/3]

void mrpt::hmtslam::CPropertiesValuesList::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator delete() [2/3]

void mrpt::hmtslam::CPropertiesValuesList::operator delete ( void ptr)
inlinenoexcept

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator delete() [3/3]

void mrpt::hmtslam::CPropertiesValuesList::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator delete[]()

void mrpt::hmtslam::CPropertiesValuesList::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator new() [1/3]

void* mrpt::hmtslam::CPropertiesValuesList::operator new ( size_t  size)
inline

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator new() [2/3]

static void* mrpt::hmtslam::CPropertiesValuesList::operator new ( size_t  size,
void ptr 
)
inlinestatic

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator new() [3/3]

void* mrpt::hmtslam::CPropertiesValuesList::operator new ( size_t  size,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator new[]()

void* mrpt::hmtslam::CPropertiesValuesList::operator new[] ( size_t  size)
inline

Definition at line 26 of file CPropertiesValuesList.h.

◆ operator=()

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

Copy operator.

Definition at line 107 of file CPropertiesValuesList.cpp.

References m_properties.

◆ serializeFrom()

void CPropertiesValuesList::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 46 of file CPropertiesValuesList.cpp.

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

◆ serializeGetVersion()

uint8_t CPropertiesValuesList::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 25 of file CPropertiesValuesList.cpp.

◆ serializeTo()

void CPropertiesValuesList::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 26 of file CPropertiesValuesList.cpp.

◆ set()

void CPropertiesValuesList::set ( const std::string propertyName,
const CSerializable::Ptr obj 
)

Sets/change the value of the property (case insensitive), making a copy of the object (or setting it to nullptr if it is the passed value)

Definition at line 149 of file CPropertiesValuesList.cpp.

References mrpt::system::os::_strcmpi(), m_properties, MRPT_END_WITH_CLEAN_UP, MRPT_START, mrpt::hmtslam::CPropertiesValuesList::TPropertyValuePair::name, and mrpt::hmtslam::CPropertiesValuesList::TPropertyValuePair::value.

◆ size()

size_t CPropertiesValuesList::size ( ) const

Returns the number of properties in the list.

Definition at line 183 of file CPropertiesValuesList.cpp.

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 70 of file CSerializable.h.

Member Data Documentation

◆ _init_CPropertiesValuesList

mrpt::rtti::CLASSINIT mrpt::hmtslam::CPropertiesValuesList::_init_CPropertiesValuesList
staticprotected

Definition at line 26 of file CPropertiesValuesList.h.

◆ className

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

Definition at line 26 of file CPropertiesValuesList.h.

◆ m_properties

std::vector<TPropertyValuePair> mrpt::hmtslam::CPropertiesValuesList::m_properties
protected

The properties list: a map between strings and objects.

Definition at line 35 of file CPropertiesValuesList.h.

Referenced by clear(), CPropertiesValuesList(), get(), getPropertyNames(), operator=(), set(), and size().

◆ runtimeClassId

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

Definition at line 26 of file CPropertiesValuesList.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019