GetFindSnapshotMixin< DerivedT > Struct Template Reference

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

Inheritance diagram for GetFindSnapshotMixin< DerivedT >:

Public Member Functions
auto *	findLatestInstance (const MemoryID &entityID, int instanceIndex=0)
	Find the latest entity instance in the given entity.
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.
auto *	findLatestSnapshot ()
const auto *	findLatestSnapshot () const
	Find the latest entity snapshot.
auto *	findLatestSnapshot (const MemoryID &entityID)
	Find the latest entity snapshot in the given entity.
const auto *	findLatestSnapshot (const MemoryID &entityID) const
auto *	findSnapshot (const MemoryID &snapshotID)
	Find an entity snapshot.
const auto *	findSnapshot (const MemoryID &snapshotID) const
auto &	getSnapshot (const MemoryID &snapshotID)
	Retrieve an entity snapshot.
const auto &	getSnapshot (const MemoryID &snapshotID) const
bool	hasSnapshot (const MemoryID &snapshotID) const
	Indicates whether a snapshot with the given ID exists.
bool	hasSnapshots () const
	Indicate whether this container contains at least one entity snapshot.
Public Member Functions inherited from GetLatestInstanceMixin< DerivedT >
auto &	getLatestInstance (int instanceIndex=0)
	Retrieve the latest entity instance.
const auto &	getLatestInstance (int instanceIndex=0) const
Public Member Functions inherited from GetLatestSnapshotMixin< DerivedT >
auto &	getLatestSnapshot (int snapshotIndex=0)
	Retrieve the latest entity snapshot.
const auto &	getLatestSnapshot (int snapshotIndex=0) const

Member Function Documentation

findLatestInstance() [1/4]

template<class DerivedT>

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

inline

Find the latest entity instance in the given entity.

Parameters

entityID

The entity's ID.

Returns

A pointer to the latest instance in the specified entity, or nullptr if the entity does not exist or it has no instance.

findLatestInstance() [2/4]

template<class DerivedT>

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

inline

findLatestInstance() [3/4]

template<class DerivedT>

auto * findLatestInstance ( int instanceIndex = 0 )

inline

findLatestInstance() [4/4]

template<class DerivedT>

const auto * findLatestInstance ( int instanceIndex = 0 ) const

inline

Find the latest entity instance.

Returns

A pointer to the latest instance, or nullptr if there is no instance.

findLatestSnapshot() [1/4]

template<class DerivedT>

auto * findLatestSnapshot ( )

inline

findLatestSnapshot() [2/4]

template<class DerivedT>

const auto * findLatestSnapshot ( ) const

inline

Find the latest entity snapshot.

Returns

A pointer to the latest instance, or nullptr if there is no snapshot.

findLatestSnapshot() [3/4]

template<class DerivedT>

auto * findLatestSnapshot ( const MemoryID & entityID )

inline

Find the latest entity snapshot in the given entity.

Parameters

entityID

The entity's ID.

Returns

A pointer to the latest snapshot in the specified entity, or nullptr if the entity does not exist or it has no snapshot.

findLatestSnapshot() [4/4]

template<class DerivedT>

const auto * findLatestSnapshot ( const MemoryID & entityID ) const

inline

findSnapshot() [1/2]

template<class DerivedT>

auto * findSnapshot ( const MemoryID & snapshotID )

inline

Find an entity snapshot.

Parameters

id	The snapshot ID.

Returns

The snapshot, or nullptr if it is missing.

findSnapshot() [2/2]

template<class DerivedT>

const auto * findSnapshot ( const MemoryID & snapshotID ) const

inline

getSnapshot() [1/2]

template<class DerivedT>

auto & getSnapshot ( const MemoryID & snapshotID )

inline

Retrieve an entity snapshot.

Parameters

id	The snapshot ID.

Returns

The snapshot if it is found.

Exceptions

armem::error::ArMemError

if it is missing.

getSnapshot() [2/2]

template<class DerivedT>

const auto & getSnapshot ( const MemoryID & snapshotID ) const

inline

hasSnapshot()

template<class DerivedT>

bool hasSnapshot ( const MemoryID & snapshotID ) const

inline

Indicates whether a snapshot with the given ID exists.

Parameters

snapshotID

The snapshot ID.

Returns

True if the snapshot exists, false otherwise.

hasSnapshots()

template<class DerivedT>

bool hasSnapshots ( ) const

inline

Indicate whether this container contains at least one entity snapshot.

Returns

True if there is at least one entity snapshot.

---

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

• RobotAPI/libraries/armem/core/base/detail/lookup_mixins.h