memoryx::ObjectMemoryObserverInterface

Overview

interface ObjectMemoryObserverInterface extends ::armarx::ObserverInterface, WorkingMemoryListenerInterface

Operation Index

requestObjectClassOnce
requestObjectClassRepeated
releaseObjectClass
getObjectInstances
getObjectInstancesByClass
getFirstObjectInstance: @brief Convenience for function getObjectInstances().
getObjectInstanceById
getFirstObjectInstanceByClass: @brief Convenience for function getFirstObjectInstanceByClass().
getInstanceChannelName

Operations

::armarx::ChannelRefBase requestObjectClassOnce(string objectClassName, optional(1) int priority)

::armarx::ChannelRefBase requestObjectClassRepeated(string objectClassName, int cycleTimeMS, optional(1) int priority)

void releaseObjectClass(::armarx::ChannelRefBase objectClassChannel)

ChannelRefBaseSequence getObjectInstances(::armarx::ChannelRefBase channel)

ChannelRefBaseSequence getObjectInstancesByClass(string objectClassName)

::armarx::ChannelRefBase getFirstObjectInstance(::armarx::ChannelRefBase channel)

@brief Convenience for function getObjectInstances(). Directly returns the first instance.

Parameters

channel: Channel of the object class

Return Value

Returns the first instance of the list getObjectInstances() returns. Null if list is empty.

::armarx::ChannelRefBase getObjectInstanceById(string id)

::armarx::ChannelRefBase getFirstObjectInstanceByClass(string objectClassName)

@brief Convenience for function getFirstObjectInstanceByClass(). Directly returns the first instance.

Parameters

objectClassName: Name of the object class

Return Value

Returns the first instance of the list getFirstObjectInstanceByClass() returns. Null if list is empty.

string getInstanceChannelName(EntityBase objectInstanceEntity)