armarx::armem::wm Namespace Reference

Namespaces
namespace	detail

Classes
class	CoreSegment
	Client-side working memory core segment. More...
class	Entity
	Client-side working memory entity. More...
class	EntityInstance
	Client-side working entity instance. More...
class	EntitySnapshot
	Client-side working memory entity snapshot. More...
class	FunctionalVisitor
	A Visitor which can be parametrized by std::function instead of inheriting and overriding. More...
class	Memory
	Client-side working memory. More...
class	ProviderSegment
	Client-side working memory provider segment. More...
class	Visitor
	A visitor for the hierarchical memory data structure. More...

Typedefs
template<class AronDtoT>
using	EntityInstanceBase = base::EntityInstanceBase<AronDtoT, EntityInstanceMetadata>
	Entity instance with a concrete ARON DTO type as data.
using	EntityInstanceData = armarx::aron::data::Dict
	Client-side working memory entity instance data (payload).
using	EntityInstanceDataPtr = armarx::aron::data::DictPtr
	Pointer type of EntityInstanceData.
using	EntityInstanceMetadata = base::EntityInstanceMetadata
	Client-side working memory entity instance metadata.

Functions
void	fromIce (const data::CoreSegment &ice, CoreSegment &coreSegment)
void	fromIce (const data::Entity &ice, Entity &entity)
void	fromIce (const data::EntityInstance &ice, EntityInstance &data)
void	fromIce (const data::EntitySnapshot &ice, EntitySnapshot &snapshot)
void	fromIce (const data::Memory &ice, Memory &memory)
void	fromIce (const data::ProviderSegment &ice, ProviderSegment &providerSegment)
void	toIce (data::CoreSegment &ice, const CoreSegment &coreSegment)
void	toIce (data::Entity &ice, const Entity &entity)
void	toIce (data::EntityInstance &ice, const EntityInstance &data)
void	toIce (data::EntitySnapshot &ice, const EntitySnapshot &snapshot)
void	toIce (data::Memory &ice, const Memory &memory)
void	toIce (data::ProviderSegment &ice, const ProviderSegment &providerSegment)
void	toMemory (Memory &m, const armarx::armem::server::wm::Memory &structure, const std::vector< EntitySnapshot > &e)
	toMemory converts a vector of entity snapshots into a working memory and considers the structure of the memory before
void	toMemory (Memory &m, const std::vector< CoreSegment > &e)
void	toMemory (Memory &m, const std::vector< Entity > &e)
void	toMemory (Memory &m, const std::vector< EntityInstance > &e)
void	toMemory (Memory &m, const std::vector< EntitySnapshot > &e)
void	toMemory (Memory &m, const std::vector< ProviderSegment > &e)

Typedef Documentation

EntityInstanceBase

template<class AronDtoT>

using EntityInstanceBase = base::EntityInstanceBase<AronDtoT, EntityInstanceMetadata>

Entity instance with a concrete ARON DTO type as data.

This is the return type of EntityInstance::withDataAs<AronDtoT>().

Usage example:

#include <RobotAPI/libraries/aron/common/aron/time.aron.generated.h>
 
armarx::arondto::Duration duration;
duration.microSeconds = 1000;
 
armarx::armem::wm::EntityInstance instance;
instance.data() = duration.toAron();
 
const armarx::armem::wm::EntityInstanceBase<armarx::arondto::Duration> cast =
instance.withDataAs<armarx::arondto::Duration>();
 
const armarx::arondto::Duration& durationOut = cast.data();
 
assert(durationOut.microseconds == 1000);

EntityInstanceData

using EntityInstanceData = armarx::aron::data::Dict

Client-side working memory entity instance data (payload).

EntityInstanceDataPtr

using EntityInstanceDataPtr = armarx::aron::data::DictPtr

Pointer type of EntityInstanceData.

EntityInstanceMetadata

using EntityInstanceMetadata = base::EntityInstanceMetadata

Client-side working memory entity instance metadata.

Function Documentation

fromIce() [1/6]

void fromIce	(	const data::CoreSegment &	ice,
		CoreSegment &	coreSegment )

fromIce() [2/6]

void fromIce	(	const data::Entity &	ice,
		Entity &	entity )

fromIce() [3/6]

void fromIce	(	const data::EntityInstance &	ice,
		EntityInstance &	data )

fromIce() [4/6]

void fromIce	(	const data::EntitySnapshot &	ice,
		EntitySnapshot &	snapshot )

fromIce() [5/6]

void fromIce	(	const data::Memory &	ice,
		Memory &	memory )

fromIce() [6/6]

void fromIce	(	const data::ProviderSegment &	ice,
		ProviderSegment &	providerSegment )

toIce() [1/6]

void toIce	(	data::CoreSegment &	ice,
		const CoreSegment &	coreSegment )

toIce() [2/6]

void toIce	(	data::Entity &	ice,
		const Entity &	entity )

toIce() [3/6]

void toIce	(	data::EntityInstance &	ice,
		const EntityInstance &	data )

toIce() [4/6]

void toIce	(	data::EntitySnapshot &	ice,
		const EntitySnapshot &	snapshot )

toIce() [5/6]

void toIce	(	data::Memory &	ice,
		const Memory &	memory )

toIce() [6/6]

void toIce	(	data::ProviderSegment &	ice,
		const ProviderSegment &	providerSegment )

toMemory() [1/6]

void toMemory	(	Memory &	m,
		const armarx::armem::server::wm::Memory &	structure,
		const std::vector< EntitySnapshot > &	e )

toMemory converts a vector of entity snapshots into a working memory and considers the structure of the memory before

Parameters

m	the (empty) new memory
structure	the server working memory for structure information
e	the vector of entity snapshots

toMemory() [2/6]

void toMemory	(	Memory &	m,
		const std::vector< CoreSegment > &	e )

toMemory() [3/6]

void toMemory	(	Memory &	m,
		const std::vector< Entity > &	e )

toMemory() [4/6]

void toMemory	(	Memory &	m,
		const std::vector< EntityInstance > &	e )

toMemory() [5/6]

void toMemory	(	Memory &	m,
		const std::vector< EntitySnapshot > &	e )

toMemory() [6/6]

void toMemory	(	Memory &	m,
		const std::vector< ProviderSegment > &	e )