Data of a memory consisting of multiple core segments. More...

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

Inheritance diagram for MemoryBase< _CoreSegmentT, _Derived >:

Classes
struct	UpdateResult

Public Types
using	ChildT = CoreSegmentT

using	CoreSegmentT = _CoreSegmentT

using	EntityInstanceT = typename EntitySnapshotT::EntityInstanceT

using	EntitySnapshotT = typename EntityT::EntitySnapshotT

using	EntityT = typename ProviderSegmentT::EntityT

using	ProviderSegmentT = typename CoreSegmentT::ProviderSegmentT

Public Types inherited from MemoryContainerBase< std::map< std::string, _CoreSegmentT >, _Derived >
using	ContainerT = std::map< std::string, _CoreSegmentT >

using	DerivedT = _Derived

Public Member Functions
CoreSegmentT &	addCoreSegment (const CoreSegmentT &coreSegment)
	Copy and insert a core segment. More...

template<class... Args>
CoreSegmentT &	addCoreSegment (const std::string &name, Args... args)
	Move and insert a core segment. More...

CoreSegmentT &	addCoreSegment (const std::string &name, aron::type::ObjectPtr coreSegmentType=nullptr, const std::vector< PredictionEngine > &predictionEngines={})
	Add an empty core segment with the given name, type and prediction engines. More...

CoreSegmentT &	addCoreSegment (CoreSegmentT &&coreSegment)
	Move and insert a core segment. More...

template<class OtherDerivedT >
void	append (const OtherDerivedT &other)
	Merge another memory into this one. More...

bool	equalsDeep (const MemoryBase &other) const

CoreSegmentT *	findCoreSegment (const MemoryID &coreSegmentID)

const CoreSegmentT *	findCoreSegment (const MemoryID &coreSegmentID) const

CoreSegmentT *	findCoreSegment (const std::string &name)

const CoreSegmentT *	findCoreSegment (const std::string &name) const

template<class CoreSegmentFunctionT >
bool	forEachCoreSegment (CoreSegmentFunctionT &&func)

template<class CoreSegmentFunctionT >
bool	forEachCoreSegment (CoreSegmentFunctionT &&func) const

template<class InstanceFunctionT >
bool	forEachInstanceIn (const MemoryID &id, InstanceFunctionT &&func)

template<class InstanceFunctionT >
bool	forEachInstanceIn (const MemoryID &id, InstanceFunctionT &&func) const

CoreSegmentT &	getCoreSegment (const MemoryID &coreSegmentID)

const CoreSegmentT &	getCoreSegment (const MemoryID &coreSegmentID) const

CoreSegmentT &	getCoreSegment (const std::string &name)

const CoreSegmentT &	getCoreSegment (const std::string &name) const

std::vector< std::string >	getCoreSegmentNames () const

std::string	getKeyString () const

bool	hasCoreSegment (const MemoryID &coreSegmentID) const

bool	hasCoreSegment (const std::string &name) const

	MemoryBase ()

	MemoryBase (const MemoryBase &other)=default

	MemoryBase (const MemoryID &id, const std::vector< PredictionEngine > &predictionEngines={})

	MemoryBase (const std::string &name, const std::vector< PredictionEngine > &predictionEngines={})

	MemoryBase (MemoryBase &&other)=default

std::string &	name ()

const std::string &	name () const

MemoryBase &	operator= (const MemoryBase &other)=default

MemoryBase &	operator= (MemoryBase &&other)=default

void	setName (const std::string &name)

std::vector< UpdateResult >	update (const Commit &commit, const bool addMissingCoreSegmentDuringUpdate=false, const bool checkMemoryName=true)
	Store all updates in `commit`. More...

UpdateResult	update (const EntityUpdate &update, const bool addMissingCoreSegmentDuringUpdate=false, const bool checkMemoryName=true)
	Store the given update. More...

Public Member Functions inherited from MemoryContainerBase< std::map< std::string, _CoreSegmentT >, _Derived >
ContainerT::iterator	begin ()

ContainerT::const_iterator	begin () const

void	clear ()

bool	empty () const

ContainerT::iterator	end ()

ContainerT::const_iterator	end () const

bool	forEachChild (ChildFunctionT &&func)

bool	forEachChild (ChildFunctionT &&func) const

	MemoryContainerBase ()

	MemoryContainerBase (const MemoryContainerBase &other)=default

	MemoryContainerBase (const MemoryID &id)

	MemoryContainerBase (MemoryContainerBase &&other)=default

MemoryContainerBase &	operator= (const MemoryContainerBase &other)=default

MemoryContainerBase &	operator= (MemoryContainerBase &&other)=default

std::size_t	size () 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

Public Member Functions inherited from PredictiveContainer< _Derived >
std::map< MemoryID, std::vector< PredictionEngine > >	getAllPredictionEngines () const

Public Member Functions inherited from Predictive< _Derived >
void	addPredictionEngine (const PredictionEngine &engine)

std::map< MemoryID, std::vector< PredictionEngine > >	getAllPredictionEngines () const

const std::vector< PredictionEngine > &	predictionEngines () const

	Predictive (const std::vector< PredictionEngine > &engines={})

void	setPredictionEngines (const std::vector< PredictionEngine > &engines)

Public Member Functions inherited from ForEachEntityInstanceMixin< _Derived >
bool	forEachInstance (InstanceFunctionT &&func)

bool	forEachInstance (InstanceFunctionT &&func) const

bool	forEachInstanceAs (AronDtoFunctionT &&func) const
	Call `func` on the data of each instance converted to Aron DTO class. More...

bool	forEachInstanceWithDataAs (EntityInstanceBaseAronDtoFunctionT &&func) const
	Call `func` on each instance with its data converted to Aron DTO class. More...

Public Member Functions inherited from ForEachEntitySnapshotMixin< _Derived >
bool	forEachSnapshot (SnapshotFunctionT &&func)

bool	forEachSnapshot (SnapshotFunctionT &&func) const

Public Member Functions inherited from ForEachEntityMixin< _Derived >
bool	forEachEntity (FunctionT &&func)

bool	forEachEntity (FunctionT &&func) const

Public Member Functions inherited from ForEachProviderSegmentMixin< _Derived >
bool	forEachProviderSegment (FunctionT &&func)

bool	forEachProviderSegment (FunctionT &&func) const

Public Member Functions inherited from GetFindInstanceMixin< _Derived >
auto *	findInstance (const MemoryID &instanceID)
	Find an entity instance. More...

const auto *	findInstance (const MemoryID &instanceID) const

auto &	getInstance (const MemoryID &instanceID)
	Retrieve an entity instance. More...

const auto &	getInstance (const MemoryID &instanceID) const

bool	hasInstance (const MemoryID &instanceID) const
	Indicate whether this container has an instance with the given ID. More...

bool	hasInstances () const
	Indicate whether this container contains at least one entity instance. More...

Public Member Functions inherited from GetFindSnapshotMixin< _Derived >
auto *	findLatestInstance (const MemoryID &entityID, int instanceIndex=0)
	Find the latest entity instance in the given entity. More...

const auto *	findLatestInstance (const MemoryID &entityID, int instanceIndex=0) const

auto *	findLatestInstance (int instanceIndex=0)

const auto *	findLatestInstance (int instanceIndex=0) const
	Find the latest entity instance. More...

auto *	findLatestSnapshot ()

const auto *	findLatestSnapshot () const
	Find the latest entity snapshot. More...

auto *	findLatestSnapshot (const MemoryID &entityID)
	Find the latest entity snapshot in the given entity. More...

const auto *	findLatestSnapshot (const MemoryID &entityID) const

auto *	findSnapshot (const MemoryID &snapshotID)
	Find an entity snapshot. More...

const auto *	findSnapshot (const MemoryID &snapshotID) const

auto &	getSnapshot (const MemoryID &snapshotID)
	Retrieve an entity snapshot. More...

const auto &	getSnapshot (const MemoryID &snapshotID) const

bool	hasSnapshot (const MemoryID &snapshotID) const
	Indicates whether a snapshot with the given ID exists. More...

bool	hasSnapshots () const
	Indicate whether this container contains at least one entity snapshot. More...

Public Member Functions inherited from GetLatestInstanceMixin< _Derived >
auto &	getLatestInstance (int instanceIndex=0)
	Retrieve the latest entity instance. More...

const auto &	getLatestInstance (int instanceIndex=0) const

Public Member Functions inherited from GetLatestSnapshotMixin< _Derived >
auto &	getLatestSnapshot (int snapshotIndex=0)
	Retrieve the latest entity snapshot. More...

const auto &	getLatestSnapshot (int snapshotIndex=0) const

Public Member Functions inherited from GetFindEntityMixin< _Derived >
auto *	findEntity (const MemoryID &entityID)
	Find an entity. More...

const auto *	findEntity (const MemoryID &entityID) const

auto &	getEntity (const MemoryID &entityID)
	Retrieve an entity. More...

const auto &	getEntity (const MemoryID &entityID) const

bool	hasEntity (const MemoryID &entityID) const

Public Member Functions inherited from GetFindProviderSegmentMixin< _Derived >
auto *	findProviderSegment (const MemoryID &providerSegmentID)
	Retrieve a provider segment. More...

const auto *	findProviderSegment (const MemoryID &providerSegmentID) const

auto &	getProviderSegment (const MemoryID &providerSegmentID)
	Retrieve a provider segment. More...

const auto &	getProviderSegment (const MemoryID &providerSegmentID) const

bool	hasProviderSegment (const MemoryID &providerSegmentID) const

Static Public Member Functions
static std::string	getLevelName ()

Protected Member Functions
std::pair< bool, CoreSegmentT * >	_addCoreSegmentIfMissing (const std::string &coreSegmentName, const bool addMissingCoreSegmentDuringUpdate)

Protected Member Functions inherited from MemoryContainerBase< std::map< std::string, _CoreSegmentT >, _Derived >
ChildT &	_addChild (const KeyT &key, ChildArgs... childArgs)

void	_checkContainerName (const std::string &gottenName, const std::string &actualName, bool emptyOk=true) const

DerivedT &	_derived ()

const DerivedT &	_derived () const

ContainerT &	container ()

const ContainerT &	container () const

Protected Member Functions inherited from MemoryItem
	~MemoryItem ()

Additional Inherited Members
Protected Attributes inherited from MemoryContainerBase< std::map< std::string, _CoreSegmentT >, _Derived >
ContainerT	_container

Protected Attributes inherited from MemoryItem
MemoryID	_id

Detailed Description

template<class _CoreSegmentT, class _Derived>
class armarx::armem::base::MemoryBase< _CoreSegmentT, _Derived >

Data of a memory consisting of multiple core segments.

Definition at line 19 of file MemoryBase.h.

Member Typedef Documentation

◆ ChildT

using ChildT = CoreSegmentT

Definition at line 43 of file MemoryBase.h.

◆ CoreSegmentT

using CoreSegmentT = _CoreSegmentT

Definition at line 37 of file MemoryBase.h.

◆ EntityInstanceT

using EntityInstanceT = typename EntitySnapshotT::EntityInstanceT

Definition at line 41 of file MemoryBase.h.

◆ EntitySnapshotT

using EntitySnapshotT = typename EntityT::EntitySnapshotT

Definition at line 40 of file MemoryBase.h.

◆ EntityT

using EntityT = typename ProviderSegmentT::EntityT

Definition at line 39 of file MemoryBase.h.

◆ ProviderSegmentT

using ProviderSegmentT = typename CoreSegmentT::ProviderSegmentT

Definition at line 38 of file MemoryBase.h.

Constructor & Destructor Documentation

◆ MemoryBase() [1/5]

MemoryBase ( )

inline

Definition at line 69 of file MemoryBase.h.

◆ MemoryBase() [2/5]

MemoryBase	(	const std::string &	name,
		const std::vector< PredictionEngine > &	predictionEngines = `{}`
	)

inlineexplicit

Definition at line 73 of file MemoryBase.h.

◆ MemoryBase() [3/5]

MemoryBase	(	const MemoryID &	id,
		const std::vector< PredictionEngine > &	predictionEngines = `{}`
	)

inlineexplicit

Definition at line 79 of file MemoryBase.h.

◆ MemoryBase() [4/5]

MemoryBase ( const MemoryBase< _CoreSegmentT, _Derived > & other )

default

◆ MemoryBase() [5/5]

MemoryBase ( MemoryBase< _CoreSegmentT, _Derived > && other )

default

Member Function Documentation

◆ _addCoreSegmentIfMissing()

std::pair<bool, CoreSegmentT*> _addCoreSegmentIfMissing	(	const std::string &	coreSegmentName,
		const bool	addMissingCoreSegmentDuringUpdate
	)

inlineprotected

Definition at line 428 of file MemoryBase.h.

Here is the caller graph for this function:

◆ addCoreSegment() [1/4]

CoreSegmentT& addCoreSegment ( const CoreSegmentT & coreSegment )

inline

Copy and insert a core segment.

Definition at line 279 of file MemoryBase.h.

◆ addCoreSegment() [2/4]

CoreSegmentT& addCoreSegment	(	const std::string &	name,
		Args...	args
	)

inline

Move and insert a core segment.

Definition at line 295 of file MemoryBase.h.

◆ addCoreSegment() [3/4]

CoreSegmentT& addCoreSegment	(	const std::string &	name,
		aron::type::ObjectPtr	coreSegmentType = `nullptr`,
		const std::vector< PredictionEngine > &	predictionEngines = `{}`
	)

inline

Add an empty core segment with the given name, type and prediction engines.

Parameters

name	The core segment name.
coreSegmentType	The core segment type (optional).
predictionEngines	The prediction engines supported by the core segment (optional).

Returns: The added core segment.

Definition at line 261 of file MemoryBase.h.

Here is the caller graph for this function:

◆ addCoreSegment() [4/4]

CoreSegmentT& addCoreSegment ( CoreSegmentT && coreSegment )

inline

Move and insert a core segment.

Definition at line 286 of file MemoryBase.h.

◆ append()

void append ( const OtherDerivedT & other )

inline

Merge another memory into this one.

Append all data and types if possible

Parameters

m	The other memory

Definition at line 363 of file MemoryBase.h.

Here is the caller graph for this function:

◆ equalsDeep()

bool equalsDeep ( const MemoryBase< _CoreSegmentT, _Derived > & other ) const

inline

Definition at line 391 of file MemoryBase.h.

◆ findCoreSegment() [1/4]

CoreSegmentT* findCoreSegment ( const MemoryID & coreSegmentID )

inline

Definition at line 147 of file MemoryBase.h.

◆ findCoreSegment() [2/4]

const CoreSegmentT* findCoreSegment ( const MemoryID & coreSegmentID ) const

inline

Definition at line 154 of file MemoryBase.h.

◆ findCoreSegment() [3/4]

CoreSegmentT* findCoreSegment ( const std::string & name )

inline

Definition at line 121 of file MemoryBase.h.

Here is the caller graph for this function:

◆ findCoreSegment() [4/4]

const CoreSegmentT* findCoreSegment ( const std::string & name ) const

inline

Definition at line 127 of file MemoryBase.h.

◆ forEachCoreSegment() [1/2]

bool forEachCoreSegment ( CoreSegmentFunctionT && func )

inline

Parameters

func	Function like: bool process(CoreSegmentT& coreSeg)

Definition at line 188 of file MemoryBase.h.

Here is the caller graph for this function:

◆ forEachCoreSegment() [2/2]

bool forEachCoreSegment ( CoreSegmentFunctionT && func ) const

inline

Parameters

func	Function like: bool process(const CoreSegmentT& coreSeg)

Definition at line 198 of file MemoryBase.h.

◆ forEachInstanceIn() [1/2]

bool forEachInstanceIn	(	const MemoryID &	id,
		InstanceFunctionT &&	func
	)

inline

Parameters

func	Function like void process(EntityInstanceT& instance)>

Definition at line 214 of file MemoryBase.h.

◆ forEachInstanceIn() [2/2]

bool forEachInstanceIn	(	const MemoryID &	id,
		InstanceFunctionT &&	func
	)		const

inline

Parameters

func	Function like void process(EntityInstanceT& instance)>

Definition at line 229 of file MemoryBase.h.

◆ getCoreSegment() [1/4]

CoreSegmentT& getCoreSegment ( const MemoryID & coreSegmentID )

inline

Definition at line 162 of file MemoryBase.h.

◆ getCoreSegment() [2/4]

const CoreSegmentT& getCoreSegment ( const MemoryID & coreSegmentID ) const

inline

Definition at line 169 of file MemoryBase.h.

◆ getCoreSegment() [3/4]

CoreSegmentT& getCoreSegment ( const std::string & name )

inline

Definition at line 134 of file MemoryBase.h.

Here is the caller graph for this function:

◆ getCoreSegment() [4/4]

const CoreSegmentT& getCoreSegment ( const std::string & name ) const

inline

Definition at line 140 of file MemoryBase.h.

◆ getCoreSegmentNames()

std::vector<std::string> getCoreSegmentNames ( ) const

inline

Definition at line 240 of file MemoryBase.h.

Here is the caller graph for this function:

◆ getKeyString()

std::string getKeyString ( ) const

inline

Definition at line 420 of file MemoryBase.h.

◆ getLevelName()

static std::string getLevelName ( )

inlinestatic

Definition at line 414 of file MemoryBase.h.

◆ hasCoreSegment() [1/2]

bool hasCoreSegment ( const MemoryID & coreSegmentID ) const

inline

Definition at line 114 of file MemoryBase.h.

◆ hasCoreSegment() [2/2]

bool hasCoreSegment ( const std::string & name ) const

inline

Definition at line 107 of file MemoryBase.h.

Here is the caller graph for this function:

◆ name() [1/2]

std::string& name ( )

inline

Definition at line 94 of file MemoryBase.h.

Here is the caller graph for this function:

◆ name() [2/2]

const std::string& name ( ) const

inline

Definition at line 100 of file MemoryBase.h.

◆ operator=() [1/2]

MemoryBase& operator= ( const MemoryBase< _CoreSegmentT, _Derived > & other )

default

◆ operator=() [2/2]

MemoryBase& operator= ( MemoryBase< _CoreSegmentT, _Derived > && other )

default

◆ setName()

void setName ( const std::string & name )

inline

Definition at line 248 of file MemoryBase.h.

Here is the caller graph for this function:

◆ update() [1/2]

std::vector<UpdateResult> update	(	const Commit &	commit,
		const bool	addMissingCoreSegmentDuringUpdate = `false`,
		const bool	checkMemoryName = `true`
	)

inline

Store all updates in commit.

Parameters

commit The commit.

Returns: The resulting memory IDs.

Definition at line 310 of file MemoryBase.h.

Here is the caller graph for this function:

◆ update() [2/2]

UpdateResult update	(	const EntityUpdate &	update,
		const bool	addMissingCoreSegmentDuringUpdate = `false`,
		const bool	checkMemoryName = `true`
	)

inline

Store the given update.

Parameters

update The update.

Returns: The resulting entity snapshot's ID.

Definition at line 329 of file MemoryBase.h.

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

RobotAPI/libraries/armem/core/base/MemoryBase.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class _CoreSegmentT, class _Derived> class armarx::armem::base::MemoryBase< _CoreSegmentT, _Derived >

Member Typedef Documentation

◆ ChildT

◆ CoreSegmentT

◆ EntityInstanceT

◆ EntitySnapshotT

◆ EntityT

◆ ProviderSegmentT

Constructor & Destructor Documentation

◆ MemoryBase() [1/5]

◆ MemoryBase() [2/5]

◆ MemoryBase() [3/5]

◆ MemoryBase() [4/5]

◆ MemoryBase() [5/5]

Member Function Documentation

◆ _addCoreSegmentIfMissing()

◆ addCoreSegment() [1/4]

◆ addCoreSegment() [2/4]

◆ addCoreSegment() [3/4]

◆ addCoreSegment() [4/4]

◆ append()

◆ equalsDeep()

◆ findCoreSegment() [1/4]

◆ findCoreSegment() [2/4]

◆ findCoreSegment() [3/4]

◆ findCoreSegment() [4/4]

◆ forEachCoreSegment() [1/2]

◆ forEachCoreSegment() [2/2]

◆ forEachInstanceIn() [1/2]

◆ forEachInstanceIn() [2/2]

◆ getCoreSegment() [1/4]

◆ getCoreSegment() [2/4]

◆ getCoreSegment() [3/4]

◆ getCoreSegment() [4/4]

◆ getCoreSegmentNames()

◆ getKeyString()

◆ getLevelName()

◆ hasCoreSegment() [1/2]

◆ hasCoreSegment() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setName()

◆ update() [1/2]

◆ update() [2/2]

template<class _CoreSegmentT, class _Derived>
class armarx::armem::base::MemoryBase< _CoreSegmentT, _Derived >