List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
EntityInstanceBase< _DataT, _MetadataT > Class Template Reference

Data of a single entity instance. More...

#include <RobotAPI/libraries/armem/core/base/EntityInstanceBase.h>

+ Inheritance diagram for EntityInstanceBase< _DataT, _MetadataT >:

Public Types

using DataT = _DataT
 
using MetadataT = _MetadataT
 

Public Member Functions

DataT & data ()
 
const DataT & data () const
 
template<class AronDtoT>
AronDtoT dataAs () const
 Get the data converted to a generated Aron DTO class.
 
 EntityInstanceBase ()
 
 EntityInstanceBase (const MemoryID &id)
 
 EntityInstanceBase (int index, const MemoryID &parentID={})
 
std::string getKeyString () const
 
int & index ()
 
int index () const
 
MetadataT & metadata ()
 
const MetadataT & metadata () const
 
void setData (const DataT &data)
 
void setMetadata (const MetadataT &metadata)
 
template<class AronDtoT>
EntityInstanceBase< AronDtoT, MetadataT > withDataAs () const
 
- Public Member Functions inherited from MemoryItem
MemoryID & id ()
 
const MemoryID & id () const
 
 MemoryItem ()
 
 MemoryItem (const MemoryID &id)
 
 MemoryItem (const MemoryItem &other)=default
 
 MemoryItem (MemoryItem &&other)=default
 
MemoryItem & operator= (const MemoryItem &other)=default
 
MemoryItem & operator= (MemoryItem &&other)=default
 

Static Public Member Functions

static std::string getLevelName ()
 

Protected Attributes

DataT _data
 The data. May be nullptr.
 
MetadataT _metadata
 The metadata.
 
- Protected Attributes inherited from MemoryItem
MemoryID _id
 

Additional Inherited Members

- Protected Member Functions inherited from MemoryItem
 ~MemoryItem ()
 

Detailed Description

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
class armarx::armem::base::EntityInstanceBase< _DataT, _MetadataT >

Data of a single entity instance.

Definition at line 83 of file EntityInstanceBase.h.

Member Typedef Documentation

◆ DataT

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
using DataT = _DataT

Definition at line 89 of file EntityInstanceBase.h.

◆ MetadataT

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
using MetadataT = _MetadataT

Definition at line 88 of file EntityInstanceBase.h.

Constructor & Destructor Documentation

◆ EntityInstanceBase() [1/3]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
EntityInstanceBase ( )
inline

Definition at line 91 of file EntityInstanceBase.h.

◆ EntityInstanceBase() [2/3]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
EntityInstanceBase ( int index,
const MemoryID & parentID = {} )
inlineexplicit

Definition at line 95 of file EntityInstanceBase.h.

◆ EntityInstanceBase() [3/3]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
EntityInstanceBase ( const MemoryID & id)
inlineexplicit

Definition at line 100 of file EntityInstanceBase.h.

Member Function Documentation

◆ data() [1/2]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
DataT & data ( )
inline

Definition at line 138 of file EntityInstanceBase.h.

◆ data() [2/2]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
const DataT & data ( ) const
inline

Definition at line 132 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ dataAs()

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
template<class AronDtoT>
AronDtoT dataAs ( ) const
inline

Get the data converted to a generated Aron DTO class.

Definition at line 160 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ getKeyString()

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
std::string getKeyString ( ) const
inline

Definition at line 184 of file EntityInstanceBase.h.

◆ getLevelName()

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
static std::string getLevelName ( )
inlinestatic

Definition at line 178 of file EntityInstanceBase.h.

◆ index() [1/2]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
int & index ( )
inline

Definition at line 106 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ index() [2/2]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
int index ( ) const
inline

Definition at line 112 of file EntityInstanceBase.h.

◆ metadata() [1/2]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
MetadataT & metadata ( )
inline

Definition at line 120 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ metadata() [2/2]

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
const MetadataT & metadata ( ) const
inline

Definition at line 126 of file EntityInstanceBase.h.

◆ setData()

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
void setData ( const DataT & data)
inline

Definition at line 144 of file EntityInstanceBase.h.

◆ setMetadata()

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
void setMetadata ( const MetadataT & metadata)
inline

Definition at line 150 of file EntityInstanceBase.h.

◆ withDataAs()

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
template<class AronDtoT>
EntityInstanceBase< AronDtoT, MetadataT > withDataAs ( ) const
inline

Definition at line 167 of file EntityInstanceBase.h.

Member Data Documentation

◆ _data

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
DataT _data
protected

The data. May be nullptr.

Definition at line 195 of file EntityInstanceBase.h.

◆ _metadata

template<class _DataT = NoData, class _MetadataT = EntityInstanceMetadata>
MetadataT _metadata
protected

The metadata.

Definition at line 192 of file EntityInstanceBase.h.

The documentation for this class was generated from the following file: