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. More...
 
 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. More...
 
MetadataT _metadata
 The metadata. More...
 
- 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 80 of file EntityInstanceBase.h.

Member Typedef Documentation

◆ DataT

using DataT = _DataT

Definition at line 86 of file EntityInstanceBase.h.

◆ MetadataT

using MetadataT = _MetadataT

Definition at line 85 of file EntityInstanceBase.h.

Constructor & Destructor Documentation

◆ EntityInstanceBase() [1/3]

EntityInstanceBase ( )
inline

Definition at line 88 of file EntityInstanceBase.h.

◆ EntityInstanceBase() [2/3]

EntityInstanceBase ( int  index,
const MemoryID &  parentID = {} 
)
inlineexplicit

Definition at line 92 of file EntityInstanceBase.h.

◆ EntityInstanceBase() [3/3]

EntityInstanceBase ( const MemoryID &  id)
inlineexplicit

Definition at line 97 of file EntityInstanceBase.h.

Member Function Documentation

◆ data() [1/2]

DataT& data ( )
inline

Definition at line 135 of file EntityInstanceBase.h.

◆ data() [2/2]

const DataT& data ( ) const
inline

Definition at line 129 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ dataAs()

AronDtoT dataAs ( ) const
inline

Get the data converted to a generated Aron DTO class.

Definition at line 157 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ getKeyString()

std::string getKeyString ( ) const
inline

Definition at line 181 of file EntityInstanceBase.h.

◆ getLevelName()

static std::string getLevelName ( )
inlinestatic

Definition at line 175 of file EntityInstanceBase.h.

◆ index() [1/2]

int& index ( )
inline

Definition at line 103 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ index() [2/2]

int index ( ) const
inline

Definition at line 109 of file EntityInstanceBase.h.

◆ metadata() [1/2]

MetadataT& metadata ( )
inline

Definition at line 117 of file EntityInstanceBase.h.

+ Here is the caller graph for this function:

◆ metadata() [2/2]

const MetadataT& metadata ( ) const
inline

Definition at line 123 of file EntityInstanceBase.h.

◆ setData()

void setData ( const DataT &  data)
inline

Definition at line 141 of file EntityInstanceBase.h.

◆ setMetadata()

void setMetadata ( const MetadataT &  metadata)
inline

Definition at line 147 of file EntityInstanceBase.h.

◆ withDataAs()

EntityInstanceBase<AronDtoT, MetadataT> withDataAs ( ) const
inline

Definition at line 164 of file EntityInstanceBase.h.

Member Data Documentation

◆ _data

DataT _data
protected

The data. May be nullptr.

Definition at line 192 of file EntityInstanceBase.h.

◆ _metadata

MetadataT _metadata
protected

The metadata.

Definition at line 189 of file EntityInstanceBase.h.

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