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. 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< DerivedT >
auto & getLatestInstance (int instanceIndex=0)
 Retrieve the latest entity instance. More...
 
const auto & getLatestInstance (int instanceIndex=0) const
 
- Public Member Functions inherited from GetLatestSnapshotMixin< DerivedT >
auto & getLatestSnapshot (int snapshotIndex=0)
 Retrieve the latest entity snapshot. More...
 
const auto & getLatestSnapshot (int snapshotIndex=0) const
 

Detailed Description

template<class DerivedT>
struct armarx::armem::base::detail::GetFindSnapshotMixin< DerivedT >

Definition at line 224 of file lookup_mixins.h.

Member Function Documentation

◆ findLatestInstance() [1/4]

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

Find the latest entity instance in the given entity.

Parameters
entityIDThe 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.

Definition at line 394 of file lookup_mixins.h.

◆ findLatestInstance() [2/4]

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

Definition at line 401 of file lookup_mixins.h.

◆ findLatestInstance() [3/4]

auto* findLatestInstance ( int  instanceIndex = 0)
inline

Definition at line 379 of file lookup_mixins.h.

◆ findLatestInstance() [4/4]

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.

Definition at line 372 of file lookup_mixins.h.

+ Here is the caller graph for this function:

◆ findLatestSnapshot() [1/4]

auto* findLatestSnapshot ( )
inline

Definition at line 324 of file lookup_mixins.h.

◆ findLatestSnapshot() [2/4]

const auto* findLatestSnapshot ( ) const
inline

Find the latest entity snapshot.

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

Definition at line 304 of file lookup_mixins.h.

+ Here is the caller graph for this function:

◆ findLatestSnapshot() [3/4]

auto* findLatestSnapshot ( const MemoryID entityID)
inline

Find the latest entity snapshot in the given entity.

Parameters
entityIDThe 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.

Definition at line 352 of file lookup_mixins.h.

◆ findLatestSnapshot() [4/4]

const auto* findLatestSnapshot ( const MemoryID entityID) const
inline

Definition at line 359 of file lookup_mixins.h.

◆ findSnapshot() [1/2]

auto* findSnapshot ( const MemoryID snapshotID)
inline

Find an entity snapshot.

Parameters
idThe snapshot ID.
Returns
The snapshot, or nullptr if it is missing.

Definition at line 266 of file lookup_mixins.h.

◆ findSnapshot() [2/2]

const auto* findSnapshot ( const MemoryID snapshotID) const
inline

Definition at line 273 of file lookup_mixins.h.

◆ getSnapshot() [1/2]

auto& getSnapshot ( const MemoryID snapshotID)
inline

Retrieve an entity snapshot.

Parameters
idThe snapshot ID.
Returns
The snapshot if it is found.
Exceptions
armem::error::ArMemErrorif it is missing.

Definition at line 286 of file lookup_mixins.h.

+ Here is the caller graph for this function:

◆ getSnapshot() [2/2]

const auto& getSnapshot ( const MemoryID snapshotID) const
inline

Definition at line 292 of file lookup_mixins.h.

◆ hasSnapshot()

bool hasSnapshot ( const MemoryID snapshotID) const
inline

Indicates whether a snapshot with the given ID exists.

Parameters
snapshotIDThe snapshot ID.
Returns
True if the snapshot exists, false otherwise.

Definition at line 253 of file lookup_mixins.h.

◆ hasSnapshots()

bool hasSnapshots ( ) const
inline

Indicate whether this container contains at least one entity snapshot.

Returns
True if there is at least one entity snapshot.

Definition at line 235 of file lookup_mixins.h.


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