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 38 of file CMHPropertiesValuesList.h.

#include <mrpt/utils/CMHPropertiesValuesList.h>

Inheritance diagram for mrpt::utils::CMHPropertiesValuesList:

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

Member Typedef Documentation

◆ const_iterator

typedef std::vector<TPropertyValueIDTriplet>::const_iterator mrpt::utils::CMHPropertiesValuesList::const_iterator

Definition at line 204 of file CMHPropertiesValuesList.h.

◆ ConstPtr

using mrpt::utils::CMHPropertiesValuesList::ConstPtr = std::shared_ptr<const CMHPropertiesValuesList >

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ iterator

typedef std::vector<TPropertyValueIDTriplet>::iterator mrpt::utils::CMHPropertiesValuesList::iterator

Definition at line 203 of file CMHPropertiesValuesList.h.

◆ Ptr

using mrpt::utils::CMHPropertiesValuesList::Ptr = std::shared_ptr< CMHPropertiesValuesList >

A typedef for the associated smart pointer

Definition at line 40 of file CMHPropertiesValuesList.h.

Constructor & Destructor Documentation

◆ CMHPropertiesValuesList() [1/2]

CMHPropertiesValuesList::CMHPropertiesValuesList ( )

Default constructor.

Definition at line 100 of file CMHPropertiesValuesList.cpp.

◆ CMHPropertiesValuesList() [2/2]

CMHPropertiesValuesList::CMHPropertiesValuesList ( const CMHPropertiesValuesList & o )

Copy constructor.

Definition at line 281 of file CMHPropertiesValuesList.cpp.

References m_properties.

◆ ~CMHPropertiesValuesList()

CMHPropertiesValuesList::~CMHPropertiesValuesList ( )

virtual

Destructor.

Definition at line 104 of file CMHPropertiesValuesList.cpp.

References mrpt::utils::clear().

Here is the call graph for this function:

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::utils::CMHPropertiesValuesList::_GetBaseClass ( )

staticprotected

◆ begin() [1/2]

iterator mrpt::utils::CMHPropertiesValuesList::begin ( )

inline

Definition at line 206 of file CMHPropertiesValuesList.h.

References m_properties.

◆ begin() [2/2]

const_iterator mrpt::utils::CMHPropertiesValuesList::begin ( ) const

inline

Definition at line 207 of file CMHPropertiesValuesList.h.

References m_properties.

◆ clear()

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.

◆ clone()

virtual mrpt::utils::CObject* mrpt::utils::CMHPropertiesValuesList::clone ( ) const

overridevirtual

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

Implements mrpt::utils::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::utils::CMHPropertiesValuesList::Create ( Args &&... args )

inlinestatic

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::utils::CMHPropertiesValuesList::CreateObject ( )

static

◆ end() [1/2]

iterator mrpt::utils::CMHPropertiesValuesList::end ( )

inline

Definition at line 208 of file CMHPropertiesValuesList.h.

References m_properties.

◆ end() [2/2]

const_iterator mrpt::utils::CMHPropertiesValuesList::end ( ) const

inline

Definition at line 209 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 118 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 138 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ getAs()

template<typename T >

T::Ptr mrpt::utils::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 77 of file CMHPropertiesValuesList.h.

References ASSERT_, MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ getElemental()

template<class T >

bool mrpt::utils::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 171 of file CMHPropertiesValuesList.h.

References ASSERT_, 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 224 of file CMHPropertiesValuesList.cpp.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::utils::CMHPropertiesValuesList::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::utils::CMHPropertiesValuesList::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::utils::CMHPropertiesValuesList::operator delete ( void * ptr )

inlinenoexcept

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator delete() [2/3]

void mrpt::utils::CMHPropertiesValuesList::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator delete() [3/3]

void mrpt::utils::CMHPropertiesValuesList::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator delete[]()

void mrpt::utils::CMHPropertiesValuesList::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator new() [1/3]

void* mrpt::utils::CMHPropertiesValuesList::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator new() [2/3]

static void* mrpt::utils::CMHPropertiesValuesList::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator new() [3/3]

void* mrpt::utils::CMHPropertiesValuesList::operator new ( size_t size )

inline

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator new[]()

void* mrpt::utils::CMHPropertiesValuesList::operator new[] ( size_t size )

inline

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ operator=()

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

Copy operator.

Definition at line 294 of file CMHPropertiesValuesList.cpp.

References m_properties.

◆ readFromStream()

void CMHPropertiesValuesList::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

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.

Parameters

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.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 56 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ remove()

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

Remove a given property, if it exists.

Definition at line 251 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 267 of file CMHPropertiesValuesList.cpp.

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

Here is the call graph for this function:

◆ setElemental()

template<class T >

void mrpt::utils::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 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.

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

Here is the call graph for this function:

◆ size()

size_t mrpt::utils::CMHPropertiesValuesList::size ( ) const

inline

Definition at line 210 of file CMHPropertiesValuesList.h.

References m_properties.

Referenced by writeToStream().

Here is the caller graph for this function:

◆ writeToMatlab()

virtual mxArray* mrpt::utils::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 89 of file CSerializable.h.

◆ writeToStream()

void CMHPropertiesValuesList::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

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.

Parameters

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.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 25 of file CMHPropertiesValuesList.cpp.

References size().

Here is the call graph for this function:

Member Data Documentation

◆ _init_CMHPropertiesValuesList

mrpt::utils::CLASSINIT mrpt::utils::CMHPropertiesValuesList::_init_CMHPropertiesValuesList

staticprotected

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ className

constexpr const char* mrpt::utils::CMHPropertiesValuesList::className = "CMHPropertiesValuesList"

static

Definition at line 40 of file CMHPropertiesValuesList.h.

◆ m_properties

std::vector<TPropertyValueIDTriplet> mrpt::utils::CMHPropertiesValuesList::m_properties

private

Definition at line 43 of file CMHPropertiesValuesList.h.

Referenced by begin(), CMHPropertiesValuesList(), end(), getElemental(), operator=(), setElemental(), and size().

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::utils::CMHPropertiesValuesList::runtimeClassId

staticprotected

Definition at line 40 of file CMHPropertiesValuesList.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

RTTI stuff

Member Typedef Documentation

◆ const_iterator

◆ ConstPtr

◆ iterator

◆ Ptr

Constructor & Destructor Documentation

◆ CMHPropertiesValuesList() [1/2]

◆ CMHPropertiesValuesList() [2/2]

◆ ~CMHPropertiesValuesList()

Member Function Documentation

◆ _GetBaseClass()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ clone()

◆ Create()

◆ CreateObject()

◆ end() [1/2]

◆ end() [2/2]

◆ get()

◆ getAnyHypothesis()

◆ getAs()

◆ getElemental()

◆ getPropertyNames()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ operator=()

◆ readFromStream()

◆ remove()

◆ removeAll()

◆ set()

◆ setElemental()

◆ setMemoryReference()

◆ size()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CMHPropertiesValuesList

◆ className

◆ m_properties

◆ runtimeClassId