Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Classes | Public Member Functions | Protected Attributes
mrpt::utils::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::utils::TParameters

Definition at line 29 of file CPropertiesValuesList.h.

#include <mrpt/utils/CPropertiesValuesList.h>

Inheritance diagram for mrpt::utils::CPropertiesValuesList:
Inheritance graph

Classes

struct  TPropertyValuePair
 

Public Member Functions

 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...
 
CSerializablePtr get (const std::string &propertyName) const
 Returns the value of the property (case insensitive), or NULL if it does not exist. More...
 
void set (const std::string &propertyName, const CSerializablePtr &obj)
 Sets/change the value of the property (case insensitive), making a copy of the object (or setting it to NULL if it is the passed value) More...
 
size_t size () const
 Returns the number of properties in the list. More...
 
std::vector< std::string > getPropertyNames () const
 Returns the name of all properties in the list. More...
 

Protected Member Functions

CSerializable virtual methods
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const MRPT_OVERRIDE
 
void readFromStream (mrpt::utils::CStream &in, int version) MRPT_OVERRIDE
 

Protected Attributes

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

RTTI stuff <br>

typedef CPropertiesValuesListPtr SmartPtr
 
static mrpt::utils::CLASSINIT _init_CPropertiesValuesList
 
static mrpt::utils::TRuntimeClassId classCPropertiesValuesList
 
static const mrpt::utils::TRuntimeClassIdclassinfo
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const MRPT_OVERRIDE
 
virtual mrpt::utils::CObjectduplicate () const MRPT_OVERRIDE
 
static mrpt::utils::CObjectCreateObject ()
 
static CPropertiesValuesListPtr Create ()
 

Member Typedef Documentation

◆ SmartPtr

A typedef for the associated smart pointer

Definition at line 32 of file CPropertiesValuesList.h.

Constructor & Destructor Documentation

◆ CPropertiesValuesList() [1/2]

mrpt::utils::CPropertiesValuesList::CPropertiesValuesList ( )

Default constructor.

◆ CPropertiesValuesList() [2/2]

mrpt::utils::CPropertiesValuesList::CPropertiesValuesList ( const CPropertiesValuesList o)

Copy constructor.

◆ ~CPropertiesValuesList()

virtual mrpt::utils::CPropertiesValuesList::~CPropertiesValuesList ( )
virtual

Destructor.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId * mrpt::utils::CPropertiesValuesList::_GetBaseClass ( )
staticprotected

◆ clear()

void mrpt::utils::CPropertiesValuesList::clear ( )

Clears the list.

◆ Create()

static CPropertiesValuesListPtr mrpt::utils::CPropertiesValuesList::Create ( )
static

◆ CreateObject()

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

◆ duplicate()

virtual mrpt::utils::CObject * mrpt::utils::CPropertiesValuesList::duplicate ( ) const
virtual

◆ get()

CSerializablePtr mrpt::utils::CPropertiesValuesList::get ( const std::string &  propertyName) const

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

◆ getPropertyNames()

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

Returns the name of all properties in the list.

◆ GetRuntimeClass()

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

◆ operator=()

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

Copy operator.

◆ readFromStream()

void mrpt::utils::CPropertiesValuesList::readFromStream ( mrpt::utils::CStream in,
int  version 
)
protected

◆ set()

void mrpt::utils::CPropertiesValuesList::set ( const std::string &  propertyName,
const CSerializablePtr &  obj 
)

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

◆ size()

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

Returns the number of properties in the list.

◆ writeToStream()

void mrpt::utils::CPropertiesValuesList::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
protected

Member Data Documentation

◆ _init_CPropertiesValuesList

mrpt::utils::CLASSINIT mrpt::utils::CPropertiesValuesList::_init_CPropertiesValuesList
staticprotected

Definition at line 32 of file CPropertiesValuesList.h.

◆ classCPropertiesValuesList

mrpt::utils::TRuntimeClassId mrpt::utils::CPropertiesValuesList::classCPropertiesValuesList
static

Definition at line 32 of file CPropertiesValuesList.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::utils::CPropertiesValuesList::classinfo
static

Definition at line 32 of file CPropertiesValuesList.h.

◆ m_properties

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

The properties list: a map between strings and objects.

Definition at line 41 of file CPropertiesValuesList.h.




Page generated by Doxygen 1.9.5 for MRPT 1.4.0 SVN: at Sun Nov 27 02:56:26 UTC 2022