ForEachEntityInstanceMixin< DerivedT > Struct Template Reference

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

Inheritance diagram for ForEachEntityInstanceMixin< DerivedT >:

Public Member Functions
template<class InstanceFunctionT>
bool	forEachInstance (InstanceFunctionT &&func)
template<class InstanceFunctionT>
bool	forEachInstance (InstanceFunctionT &&func) const
template<class AronDtoFunctionT>
bool	forEachInstanceAs (AronDtoFunctionT &&func) const
	Call func on the data of each instance converted to Aron DTO class.
template<class EntityInstanceBaseAronDtoFunctionT>
bool	forEachInstanceWithDataAs (EntityInstanceBaseAronDtoFunctionT &&func) const
	Call func on each instance with its data converted to Aron DTO class.

Member Function Documentation

forEachInstance() [1/2]

template<class DerivedT>

template<class InstanceFunctionT>

bool forEachInstance ( InstanceFunctionT && func )

inline

Parameters

func	Function like: bool process(EntityInstanceT& instance)>

forEachInstance() [2/2]

template<class DerivedT>

template<class InstanceFunctionT>

bool forEachInstance ( InstanceFunctionT && func ) const

inline

Parameters

func	Function like: bool process(const EntityInstanceT& instance)

forEachInstanceAs()

template<class DerivedT>

template<class AronDtoFunctionT>

bool forEachInstanceAs ( AronDtoFunctionT && func ) const

inline

Call func on the data of each instance converted to Aron DTO class.

().forEachEntityInstanceAs([](my::arondto::CoolData data)
{
     ...
});

The Aron DTO type is deduced from the passed function's first argument.

Parameters

func	Function like: bool process(my::arondto::CoolData data)

forEachInstanceWithDataAs()

template<class DerivedT>

template<class EntityInstanceBaseAronDtoFunctionT>

bool forEachInstanceWithDataAs ( EntityInstanceBaseAronDtoFunctionT && func ) const

inline

Call func on each instance with its data converted to Aron DTO class.

().forEachEntityInstanceWithDataAs(
   [](armem::wm::EntityInstanceBase<my::arondto::CoolData> instance)
{
     const armarx::armem::MemoryID id = instance.id();
     const armarx::DateTime timestamp = instance.id().timestamp;
     const armarx::arondto::Duration& data = instance.data();
     ...
});

Compared to forEachInstanceAs(), this function allows accessing the full metadata of the instances in addition to the payload data converted to the ARON DTO.

The Aron DTO type is deduced from the passed function's signature.

Parameters

func	Function like: bool process(armem::wm::EntityInstanceBase<my::arondto::CoolData> instance)

---

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

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