EntitySnapshot Class Reference

Client-side working memory entity snapshot. More...

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

+ Inheritance diagram for EntitySnapshot:

Additional Inherited Members

- Public Types inherited from EntitySnapshotBase< EntityInstance, EntitySnapshot >
using EntityInstanceT = EntityInstance
 
- Public Types inherited from MemoryContainerBase< std::vector< EntityInstance >, EntitySnapshot >
using ContainerT = std::vector< EntityInstance >
 
using DerivedT = EntitySnapshot
 
- Public Member Functions inherited from EntitySnapshotBase< EntityInstance, EntitySnapshot >
EntityInstanceTaddInstance ()
 
EntityInstanceTaddInstance (const EntityInstanceT &instance)
 Add a single instance with data. More...
 
EntityInstanceTaddInstance (EntityInstanceT &&instance)
 
 EntitySnapshotBase ()
 
 EntitySnapshotBase (const EntitySnapshotBase &other)=default
 
 EntitySnapshotBase (const MemoryID &id)
 
 EntitySnapshotBase (EntitySnapshotBase &&other)=default
 
 EntitySnapshotBase (Time time, const MemoryID &parentID={})
 
bool equalsDeep (const DerivedT &other) const
 
EntityInstanceTfindInstance (const MemoryID &instanceID)
 
const EntityInstanceTfindInstance (const MemoryID &instanceID) const
 
EntityInstanceTfindInstance (int index)
 
const EntityInstanceTfindInstance (int index) const
 
bool forEachInstance (InstanceFunctionT &&func)
 
bool forEachInstance (InstanceFunctionT &&func) const
 
bool forEachInstanceIn (const MemoryID &id, InstanceFunctionT &&func)
 
bool forEachInstanceIn (const MemoryID &id, InstanceFunctionT &&func) const
 
EntityInstanceTgetInstance (const MemoryID &instanceID)
 Get the given instance. More...
 
const EntityInstanceTgetInstance (const MemoryID &instanceID) const
 
EntityInstanceTgetInstance (int index)
 Get the given instance. More...
 
const EntityInstanceTgetInstance (int index) const
 
std::vector< int > getInstanceIndices () const
 
std::string getKeyString () const
 
bool hasInstance (const MemoryID &instanceID) const
 
bool hasInstance (int index) const
 
bool hasInstances () const
 Indicate whether this snapshot has any instances. More...
 
EntitySnapshotBaseoperator= (const EntitySnapshotBase &other)=default
 
EntitySnapshotBaseoperator= (EntitySnapshotBase &&other)=default
 
Timetime ()
 
const Timetime () const
 
void update (const EntityUpdate &update)
 
- Public Member Functions inherited from MemoryContainerBase< std::vector< EntityInstance >, EntitySnapshot >
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
 
MemoryContainerBaseoperator= (const MemoryContainerBase &other)=default
 
MemoryContainerBaseoperator= (MemoryContainerBase &&other)=default
 
std::size_t size () const
 
- Public Member Functions inherited from MemoryItem
MemoryIDid ()
 
const MemoryIDid () const
 
 MemoryItem ()
 
 MemoryItem (const MemoryID &id)
 
 MemoryItem (const MemoryItem &other)=default
 
 MemoryItem (MemoryItem &&other)=default
 
MemoryItemoperator= (const MemoryItem &other)=default
 
MemoryItemoperator= (MemoryItem &&other)=default
 
- Public Member Functions inherited from FindInstanceDataMixinForSnapshot< EntitySnapshot >
aron::data::DictPtr findInstanceData (int instanceIndex=0) const
 
std::optional< AronDtoT > findInstanceDataAs (int instanceIndex=0) const
 
- Static Public Member Functions inherited from EntitySnapshotBase< EntityInstance, EntitySnapshot >
static std::string getLevelName ()
 
- Protected Member Functions inherited from MemoryContainerBase< std::vector< EntityInstance >, EntitySnapshot >
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
 
ContainerTcontainer ()
 
const ContainerTcontainer () const
 
- Protected Member Functions inherited from MemoryItem
 ~MemoryItem ()
 
- Protected Attributes inherited from MemoryContainerBase< std::vector< EntityInstance >, EntitySnapshot >
ContainerT _container
 
- Protected Attributes inherited from MemoryItem
MemoryID _id
 

Detailed Description

Client-side working memory entity snapshot.

See also
base::EntitySnapshotBase

Definition at line 80 of file memory_definitions.h.


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