GetFindInstanceMixin< DerivedT > Struct Template Reference
#include <RobotAPI/libraries/armem/core/base/detail/lookup_mixins.h>
Inheritance diagram for GetFindInstanceMixin< DerivedT >:Public Member Functions | |
| auto * | findInstance (const MemoryID &instanceID) |
| Find an entity instance. | |
| const auto * | findInstance (const MemoryID &instanceID) const |
| auto & | getInstance (const MemoryID &instanceID) |
| Retrieve an entity instance. | |
| const auto & | getInstance (const MemoryID &instanceID) const |
| bool | hasInstance (const MemoryID &instanceID) const |
| Indicate whether this container has an instance with the given ID. | |
| bool | hasInstances () const |
| Indicate whether this container contains at least one entity instance. | |
Detailed Description
template<class DerivedT>
struct armarx::armem::base::detail::GetFindInstanceMixin< DerivedT >
struct armarx::armem::base::detail::GetFindInstanceMixin< DerivedT >
Definition at line 81 of file lookup_mixins.h.
Member Function Documentation
◆ findInstance() [1/2]
template<class DerivedT>
|
inline |
Find an entity instance.
- Parameters
-
id The instance ID.
- Returns
- The instance or nullptr if it is missing.
Definition at line 119 of file lookup_mixins.h.
Here is the call graph for this function: Here is the caller graph for this function:◆ findInstance() [2/2]
template<class DerivedT>
|
inline |
◆ getInstance() [1/2]
template<class DerivedT>
|
inline |
Retrieve an entity instance.
- Parameters
-
id The instance ID.
- Returns
- The instance if it is found.
- Exceptions
-
armem::error::ArMemError if it is missing.
Definition at line 139 of file lookup_mixins.h.
Here is the call graph for this function: Here is the caller graph for this function:◆ getInstance() [2/2]
template<class DerivedT>
|
inline |
◆ hasInstance()
template<class DerivedT>
|
inline |
Indicate whether this container has an instance with the given ID.
- Parameters
-
instanceID The instance ID.
- Returns
- ... WIP
Definition at line 108 of file lookup_mixins.h.
Here is the call graph for this function:◆ hasInstances()
template<class DerivedT>
|
inline |
Indicate whether this container contains at least one entity instance.
- Returns
- True if there is at least one entity instance.
Definition at line 90 of file lookup_mixins.h.
Here is the call graph for this function:The documentation for this struct was generated from the following file:
- RobotAPI/libraries/armem/core/base/detail/lookup_mixins.h
