Client-side working entity instance. More...

#include <RobotAPI/libraries/armem/core/wm/memory_definitions.h>

Inheritance diagram for EntityInstance:

Public Member Functions
	EntityInstanceBase ()

	EntityInstanceBase (const MemoryID &id)

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

bool	equalsDeep (const EntityInstance &other) const

void	update (const EntityUpdate &update)
	Fill `*this` with the update's values.

Public Member Functions inherited from EntityInstanceBase< EntityInstanceDataPtr, EntityInstanceMetadata >
DataT &	data ()

DataT &	data ()

const DataT &	data () const

const DataT &	data () const

AronDtoT	dataAs () const
	Get the data converted to a generated Aron DTO class.

AronDtoT	dataAs () const
	Get the data converted to a generated Aron DTO class.

	EntityInstanceBase ()

	EntityInstanceBase ()

	EntityInstanceBase (const MemoryID &id)

	EntityInstanceBase (const MemoryID &id)

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

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

std::string	getKeyString () const

std::string	getKeyString () const

int &	index ()

int &	index ()

int	index () const

int	index () const

MetadataT &	metadata ()

MetadataT &	metadata ()

const MetadataT &	metadata () const

const MetadataT &	metadata () const

void	setData (const DataT &data)

void	setData (const DataT &data)

void	setMetadata (const MetadataT &metadata)

void	setMetadata (const MetadataT &metadata)

EntityInstanceBase< AronDtoT, MetadataT >	withDataAs () const

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

Additional Inherited Members
Public Types inherited from EntityInstanceBase< EntityInstanceDataPtr, EntityInstanceMetadata >
using	DataT

using	MetadataT

Static Public Member Functions inherited from EntityInstanceBase< EntityInstanceDataPtr, EntityInstanceMetadata >
static std::string	getLevelName ()

static std::string	getLevelName ()

Protected Member Functions inherited from MemoryItem
	~MemoryItem ()

Protected Attributes inherited from EntityInstanceBase< EntityInstanceDataPtr, EntityInstanceMetadata >
DataT	_data
	The data. May be nullptr.

DataT	_data
	The data. May be nullptr.

MetadataT	_metadata
	The metadata.

MetadataT	_metadata
	The metadata.

Protected Attributes inherited from MemoryItem
MemoryID	_id

Detailed Description

Client-side working entity instance.

See also: base::EntityInstanceBase

Definition at line 32 of file memory_definitions.h.

Member Function Documentation

◆ EntityInstanceBase() [1/3]

EntityInstanceBase ( )

inline

Definition at line 91 of file EntityInstanceBase.h.

◆ EntityInstanceBase() [2/3]

EntityInstanceBase ( const MemoryID & id )

inlineexplicit

Definition at line 100 of file EntityInstanceBase.h.

◆ EntityInstanceBase() [3/3]

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

inlineexplicit

Definition at line 95 of file EntityInstanceBase.h.

◆ equalsDeep()

bool equalsDeep ( const EntityInstance & other ) const

Definition at line 16 of file memory_definitions.cpp.

Here is the call graph for this function:

◆ update()

void update ( const EntityUpdate & update )

Fill *this with the update's values.

Parameters

update	The update.
index	The instances index.

Definition at line 30 of file memory_definitions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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

RobotAPI/libraries/armem/core/wm/memory_definitions.h
RobotAPI/libraries/armem/core/wm/memory_definitions.cpp

Public Member Functions