Client-side working memory provider segment. More...

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

Inheritance diagram for ProviderSegment:

Additional Inherited Members
Public Types inherited from ProviderSegmentBase< Entity, ProviderSegment >
using	ChildT = EntityT

using	EntityInstanceT = typename EntitySnapshotT::EntityInstanceT

using	EntitySnapshotT = typename EntityT::EntitySnapshotT

using	EntityT = Entity

Public Types inherited from MemoryContainerBase< std::map< std::string, Entity >, ProviderSegment >
using	ContainerT = std::map< std::string, Entity >

using	DerivedT = ProviderSegment

Public Member Functions inherited from ProviderSegmentBase< Entity, ProviderSegment >
EntityT &	addEntity (const EntityT &entity)
	Copy and insert an entity. More...

EntityT &	addEntity (const std::string &name)
	Add an empty entity with the given name. More...

EntityT &	addEntity (const std::string &name, Args... args)
	Insert an entity in-place. More...

EntityT &	addEntity (EntityT &&entity)
	Move and insert an entity. More...

void	append (const OtherDerivedT &other)

bool	equalsDeep (const DerivedT &other) const

EntityT *	findEntity (const MemoryID &entityID)

const EntityT *	findEntity (const MemoryID &entityID) const

EntityT *	findEntity (const std::string &name)

const EntityT *	findEntity (const std::string &name) const

bool	forEachEntity (EntityFunctionT &&func)

bool	forEachEntity (EntityFunctionT &&func) const

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

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

EntityT &	getEntity (const MemoryID &entityID)

const EntityT &	getEntity (const MemoryID &entityID) const

EntityT &	getEntity (const std::string &name)

const EntityT &	getEntity (const std::string &name) const

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

std::string	getKeyString () const

bool	hasEntity (const MemoryID &entityID) const

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

std::string &	name ()

const std::string &	name () const

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

ProviderSegmentBase &	operator= (ProviderSegmentBase &&other)=default

	ProviderSegmentBase ()

	ProviderSegmentBase (const MemoryID id, aron::type::ObjectPtr aronType=nullptr, const std::vector< PredictionEngine > &predictionEngines={})

	ProviderSegmentBase (const ProviderSegmentBase &other)=default

	ProviderSegmentBase (const std::string &name, aron::type::ObjectPtr aronType=nullptr, const std::vector< PredictionEngine > &predictionEngines={})

	ProviderSegmentBase (const std::string &name, const MemoryID parentID, aron::type::ObjectPtr aronType=nullptr, const std::vector< PredictionEngine > &predictionEngines={})

	ProviderSegmentBase (ProviderSegmentBase &&other)=default

UpdateResult	update (const EntityUpdate &update)
	Updates an entity's history. More...

Public Member Functions inherited from MemoryContainerBase< std::map< std::string, Entity >, ProviderSegment >
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 AronTyped
aron::type::ObjectPtr &	aronType ()

aron::type::ObjectPtr	aronType () const

	AronTyped (aron::type::ObjectPtr aronType=nullptr)

bool	hasAronType () const

void	setAronType (aron::type::ObjectPtr aronType)

Public Member Functions inherited from Predictive< ProviderSegment >
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< ProviderSegment >
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< ProviderSegment >
bool	forEachSnapshot (SnapshotFunctionT &&func)

bool	forEachSnapshot (SnapshotFunctionT &&func) const

Public Member Functions inherited from GetFindInstanceMixin< ProviderSegment >
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< ProviderSegment >
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< ProviderSegment >
auto &	getLatestInstance (int instanceIndex=0)
	Retrieve the latest entity instance. More...

const auto &	getLatestInstance (int instanceIndex=0) const

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

const auto &	getLatestSnapshot (int snapshotIndex=0) const

Public Member Functions inherited from FindInstanceDataMixin< ProviderSegment >
aron::data::DictPtr	findLatestInstanceData (const MemoryID &entityID, int instanceIndex=0) const

std::optional< AronDtoT >	findLatestInstanceDataAs (const MemoryID &entityID, int instanceIndex=0) const

Static Public Member Functions inherited from ProviderSegmentBase< Entity, ProviderSegment >
static std::string	getLevelName ()

Protected Member Functions inherited from MemoryContainerBase< std::map< std::string, Entity >, ProviderSegment >
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 ()

Protected Attributes inherited from MemoryContainerBase< std::map< std::string, Entity >, ProviderSegment >
ContainerT	_container

Protected Attributes inherited from MemoryItem
MemoryID	_id

Protected Attributes inherited from AronTyped
aron::type::ObjectPtr	_aronType
	The expected Aron type. May be nullptr, in which case no type information is available. More...

Detailed Description

Client-side working memory provider segment.

See also: base::ProviderSegmentBase

Definition at line 105 of file memory_definitions.h.

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

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

Additional Inherited Members

Detailed Description