ManagedIceObject Class Referenceabstract

The ManagedIceObject is the base class for all ArmarX objects. More...

#include <ArmarXCore/core/ManagedIceObject.h>

Inherits Object, and Logging.

Inherited by ViewSelectionConfigDialog [virtual], AffordancePipelineGuiConfigDialog [virtual], ArVizComponentPluginUser [virtual], CartesianPositionControlComponentPluginUser [virtual], Component [virtual], DebugDrawerHelperComponentPluginUser [virtual], DebugObserverComponentPluginUser [virtual], ExternalApplicationManagerDependency [virtual], ExternalApplicationManagerStarter [virtual], FrameTrackingComponentPluginUser [virtual], GraspCandidateObserverComponentPluginUser [virtual], GraspGeneratorComponentPluginUser [virtual], GraspSelectionManagerComponentPluginUser [virtual], HandUnitComponentPluginUser [virtual], HandUnitConfigDialog [virtual], JsonStorageComponentPluginUser [virtual], KinematicUnitComponentPluginUser [virtual], KinematicUnitConfigDialog [virtual], LightweightRemoteGuiComponentPluginUser [virtual], LocalTimeServer [virtual], MMMPlayerConfigDialog [virtual], MessageDisplayComponentPluginUser [virtual], MotionPlanningServerConfigDialog [virtual], NJointControllerBase [virtual], NaturalIKComponentPluginUser [virtual], ObjectPoseClientPluginUser [virtual], ObjectPoseProviderPluginUser [virtual], PlannedMotionProviderComponentPluginUser [virtual], PlatformUnitComponentPluginUser [virtual], PlatformUnitConfigDialog [virtual], PointCloudVisualizationConfigDialog [virtual], PrimitiveExtractionConfigDialog [virtual], RemoteGuiComponentPluginUser [virtual], RemoteState [virtual], RobotNameServiceComponentPluginUser [virtual], RobotPlacementComponentPluginUser [virtual], RobotStateComponentPluginUser [virtual], RobotUnitComponentPluginUser [virtual], RobotUnitEmergencyStopMaster [virtual], RobotUnitObserverComponentPluginUser [virtual], RobotUnitSubUnit [virtual], SemanticGraphStorageComponentPluginUser [virtual], SimpleConfigDialog [virtual], SimulatorTimeServerProxy [virtual], SkillManagerComponentPluginUser [virtual], SkillProviderComponentPluginUser [virtual], StateWatcher, StatechartEventDistributor [virtual], StatechartListenerComponentPluginUser [virtual], TCPMoverConfigDialog [virtual], ThreadList [virtual], TrajectoryPlayerComponentPluginUser [virtual], ManagerNode [virtual], WorkerNode [virtual], PluginUser [virtual], PluginUser [virtual], ReadOnlyPluginUser [virtual], ReadWritePluginUser [virtual], ComponentPluginUser [virtual], Receiver [virtual], ComponentPluginUser [virtual], WorkerNode [virtual], SceneEditorConfigDialog [virtual], PriorEditorConfigDialog, WorkingMemoryController, and UserAssistedSegmenterConfigDialog [virtual].

Classes

struct  Impl
 

Public Types

using PeriodicTaskPtr = IceUtil::Handle<SimplePeriodicTask<std::function<void(void)>>>
 

Public Member Functions

void enableProfiler (bool enable)
 setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer)
 
std::string generateSubObjectName (const std::string &subObjectName)
 Generates a unique name for a sub object from a general name.
 
ArmarXManagerPtr getArmarXManager () const
 Returns the ArmarX manager used to add and remove components.
 
ManagedIceObjectConnectivity getConnectivity () const
 Retrieve connectivity of the object (topcis as well as proxies)
 
virtual std::string getDefaultName () const =0
 Retrieve default name of component.
 
IceManagerPtr getIceManager () const
 Returns the IceManager.
 
VariantBasePtr getMetaInfo (const std::string &id)
 
StringVariantBaseMap getMetaInfoMap () const
 
std::string getName () const
 Retrieve name of object.
 
Ice::ObjectAdapterPtr getObjectAdapter () const
 Returns object's Ice adapter.
 
ArmarXObjectSchedulerPtr getObjectScheduler () const
 
PeriodicTaskPtr getPeriodicTask (const std::string &name)
 
Profiler::ProfilerPtr getProfiler () const
 getProfiler returns an instance of armarx::Profiler
 
template<class ProxyTarg, class... Args>
void getProxy (const char *name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&... args)
 
template<class ProxyType>
ProxyType getProxy (const std::string &name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 Retrieves a proxy object.
 
template<class ProxyTarg, class... Args>
void getProxy (const std::string &name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&... args)
 
template<class ProxyTarg, class... Args>
void getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const char *name, Args &&... args)
 
template<class ProxyTarg, class... Args>
void getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const std::string &name, Args &&... args)
 Assigns a proxy to proxy.
 
Ice::ObjectPrx getProxy (long timeoutMs=0, bool waitForScheduler=true) const
 Returns the proxy of this object (optionally it waits for the proxy)
 
template<class Prx>
Prx getProxy (long timeoutMs=0, bool waitForScheduler=true) const
 
template<class ProxyType>
void getProxy (ProxyType &proxy, const char *name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 Overload to allow using string literals as name (solve ambiguous overload).
 
template<class Prx>
void getProxy (Prx &prx, long timeoutMs=0, bool waitForScheduler=true) const
 
int getState () const
 Retrieve current state of the ManagedIceObject.
 
template<class TopicProxyType>
TopicProxyType getTopic (const std::string &name)
 Returns a proxy of the specified topic.
 
template<class TopicProxyType>
void getTopic (TopicProxyType &topicProxy, const std::string &name)
 Assigns a proxy of the specified topic to topicProxy.
 
std::vector< std::string > getUnresolvedDependencies () const
 returns the names of all unresolved dependencies
 
 ManagedIceObject (ManagedIceObject const &other)
 
void offeringTopic (const std::string &name)
 Registers a topic for retrival after initialization.
 
void preambleGetTopic (std::string const &name)
 
void setMetaInfo (const std::string &id, const VariantBasePtr &value)
 Allows to set meta information that can be queried live via Ice interface on the ArmarXManager.
 
void startPeriodicTask (const std::string &uniqueName, std::function< void(void)> f, int periodMs, bool assureMeanInterval=false, bool forceSystemTime=true)
 
bool stopPeriodicTask (const std::string &name)
 
bool unsubscribeFromTopic (const std::string &name)
 Unsubscribe from a topic.
 
bool usingProxy (const std::string &name, const std::string &endpoints="")
 Registers a proxy for retrieval after initialization and adds it to the dependency list.
 
void usingTopic (const std::string &name, bool orderedPublishing=false)
 Registers a proxy for subscription after initialization.
 
void waitForObjectScheduler ()
 Waits until the ObjectScheduler could resolve all dependencies.
 
void waitForProxy (std::string const &name, bool addToDependencies)
 
- Public Member Functions inherited from Logging
SpamFilterDataPtr deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
 disables the logging for the current line for the given amount of seconds.
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 

Static Public Member Functions

static std::string generateSubObjectName (const std::string &superObjectName, const std::string &subObjectName)
 Generates a unique name for a sub object from a general name and unique name.
 
static std::string GetObjectStateAsString (int state)
 

Static Public Attributes

static const ManagedIceObjectPtr NullPtr
 A nullptr to be used when a const ref to a nullptr is required.
 

Protected Member Functions

template<class PluginT, class... ParamsT>
PluginT * addPlugin (const std::string prefix="", ParamsT &&... params)
 
template<class PluginT, class... ParamsT>
void addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&... params)
 
template<class PluginT, class... ParamsT>
void addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&... params)
 
Ice::CommunicatorPtr getCommunicator () const
 
std::unique_ptr< ManagedIceObjectPlugin > & getPluginPointer (std::type_info const &type, std::string const &prefix)
 
 ManagedIceObject ()
 Protected default constructor.
 
virtual void onConnectComponent ()=0
 Pure virtual hook for the subclass.
 
virtual void onDisconnectComponent ()
 Hook for subclass.
 
virtual void onExitComponent ()
 Hook for subclass.
 
virtual void onInitComponent ()=0
 Pure virtual hook for the subclass.
 
virtual void postOnConnectComponent ()
 
virtual void postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
virtual void preOnConnectComponent ()
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 
virtual void preOnInitComponent ()
 
bool removeProxyDependency (const std::string &name)
 This function removes the dependency of this object on the in parameter name specified object.
 
void setName (std::string name)
 Override name of well-known object.
 
void terminate ()
 Initiates termination of this IceManagedObject.
 
 ~ManagedIceObject () override
 
- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtr & getLogSender () const
 Retrieve log sender.
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 

Friends

class ArmarXManager
 
class ArmarXObjectScheduler
 
class Component
 
class ManagedIceObjectPlugin
 

Additional Inherited Members

- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

The ManagedIceObject is the base class for all ArmarX objects.

ManagedIceObject are the ArmarX equivalent to well-known Ice objects. A defined lifecycle is guaranteed which and state dependent interface is provided by the following framework hooks:

  • ManagedIceObjects::onInitComponent()
  • ManagedIceObjects::onConnectComponent()
  • ManagedIceObjects::onExitComponent()
Lifecyle of a ManagedIceObject managed by the ArmarXObjectScheduler

Every subclass of ManagedIceObject can specify dependent proxies and topics as well as offered topics in ManagedIceObjects::onInitComponent(). These connectivity parameters are specified through the following methods:

  • MangedIceObject::usingProxy()
  • MangedIceObject::usingTopic()
  • MangedIceObject::offeringTopic()

These dependencies are resolved at runtime and can be visualized. Additionally it is possible to handle the case of crashed dependencies.

MyManagedIceObject::onInitComponent()
{
// component depends on proxy "MyDataProvider"
usingProxy("MyDataProvider");
// component wants to subscribe to topic "News"
usingTopic("News");
// component will offer topic "FilteredNews"
offeringTopic("FilteredNews");
}
void offeringTopic(const std::string &name)
Registers a topic for retrival after initialization.
Definition ManagedIceObject.cpp:300
bool usingProxy(const std::string &name, const std::string &endpoints="")
Registers a proxy for retrieval after initialization and adds it to the dependency list.
Definition ManagedIceObject.cpp:154
void usingTopic(const std::string &name, bool orderedPublishing=false)
Registers a proxy for subscription after initialization.
Definition ManagedIceObject.cpp:254
See also
ArmarXObjectScheduler

Member Typedef Documentation

◆ PeriodicTaskPtr

using PeriodicTaskPtr = IceUtil::Handle<SimplePeriodicTask<std::function<void(void)>>>

Constructor & Destructor Documentation

◆ ManagedIceObject() [1/2]

◆ ManagedIceObject() [2/2]

ManagedIceObject ( )
protected

Protected default constructor.

Used for virtual inheritance. Use createManagedIceObject() instead.

◆ ~ManagedIceObject()

~ManagedIceObject ( )
overrideprotected

Member Function Documentation

◆ addPlugin() [1/3]

template<class PluginT, class... ParamsT>
PluginT * addPlugin ( const std::string prefix = "",
ParamsT &&... params )
inlineprotected

◆ addPlugin() [2/3]

template<class PluginT, class... ParamsT>
void addPlugin ( PluginT *& targ,
const std::string prefix = "",
ParamsT &&... params )
inlineprotected

◆ addPlugin() [3/3]

template<class PluginT, class... ParamsT>
void addPlugin ( std::experimental::observer_ptr< PluginT > & targ,
const std::string prefix = "",
ParamsT &&... params )
inlineprotected

◆ enableProfiler()

void enableProfiler ( bool enable)

setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer)

◆ generateSubObjectName() [1/2]

std::string generateSubObjectName ( const std::string & subObjectName)

Generates a unique name for a sub object from a general name.

(given the current object name is unique)

Parameters
subObjectNameThe sub object's name (has to be unique among the sub objects)
Returns
The unique sub object name

Generates a unique name for a sub object from a general name. E.g.: Two objects A (object name "A") and B (object name "B") have a DebugDrawer as sub object. A and B can generate different object names for the debug drawer by calling this function with the same name "DebugDrawer". Additionally the created name contains the super object's name.

◆ generateSubObjectName() [2/2]

std::string generateSubObjectName ( const std::string & superObjectName,
const std::string & subObjectName )
static

Generates a unique name for a sub object from a general name and unique name.

Parameters
superObjectNameThe name of the super object (has to be unique)
subObjectNameThe sub object's name (has to be unique among the sub objects)
Returns

◆ getArmarXManager()

ArmarXManagerPtr getArmarXManager ( ) const

Returns the ArmarX manager used to add and remove components.

@retrun pointer to the armarXManager

◆ getCommunicator()

Ice::CommunicatorPtr getCommunicator ( ) const
protected

◆ getConnectivity()

ManagedIceObjectConnectivity getConnectivity ( ) const

Retrieve connectivity of the object (topcis as well as proxies)

Returns
connectivity

◆ getDefaultName()

virtual std::string getDefaultName ( ) const
pure virtual

Retrieve default name of component.

Implement this method in each IceManagedObject. The default name of a is used if no name is specified in the factory method.

Returns
default name of the component (e.g. "KinematicUnit")

Implemented in ik_demo, ManagerNode, WorkerNode, AffordanceExtraction, AffordancePipelineGuiConfigDialog, AffordancePipelineVisualization, AffordanceUpdateListener, ArMarkerExternalCameraCalibration, ArmarXComponentWidgetController, ArmarXFileLogger, ArmarXPhysicsWorldVisualization, ArmarXSimulatorWindow, ArmarXTimeserver, ProprioceptionStressTest, LegacyRobotStateMemoryAdapter, MemoryNameSystem, GraspMemory, HumanMemory, LaserScansMemory, ObjectMemory, ReasoningMemory, RobotStateMemory, VisionMemory, AronComponentConfigExample, ArticulatedObjectLocalizerExample, ArticulatedObjectLocalizerDynamicSimulation, ArVizExample, ArVizInteractExample, ArVizStorage, AStarPathPlanner, ATINetFTUnit, BatteryWidget, BlurrinessMetric, BringObjectGroupStatechartContext, ClientState, CoFusionProcessor, CollisionCheckerComponent, TaskOutcomeDebugger, ConditionHandler, Component, Component, Component, Component, Component, Component, Component, Component, Component, RTUnit, CoupledInteractionGroupStatechartContext, CropRobotFromImage, CyberGloveObserver, DebugDrawerComponent, DebugDrawerToArVizComponent, DebugObserver, DemoStateManager, DenseCRFSegmentationProcessor, DepthImageProviderDynamicSimulation, Receiver, DHParameterOptimizationLogger, DiagnosticsSubUnit, DMPComponent, DSObstacleAvoidance, DummyAgentReporter, DummyCriterion, DummyObjectLocalizer, DummyTextToSpeech, DummyWorldStateObserver, DynamicObstacleManager, DynamicRemoteState, EfficientRANSACPrimitiveExtractor, EmergencyStopMaster, EmergencyStopNode< T >, EmergencyStopWidget, ExampleMemory, ExampleMemoryClient, ExternalApplicationManager, ExternalApplicationManagerDependency, ExternalApplicationManagerStarter, FaceRecognition, FakeObjectDetector, FakeWorkingMemoryObjectLocalizer, FamiliarObjectDetectionExample, FilterKnownObjects, FlyCaptureImageProvider, ForceTorqueObserver, ForceTorqueUnit, ForceTorqueUnitDynamicSimulation, ForceTorqueUnitSimulation, FrameTracking, FunctionApproximator, GamepadControlUnit, GamepadUnit, GamepadUnitObserver, GeneralPurposeMemory, GraspCandidateObserver, GraspingManager, GraspProviderExample, GraspSelectionManager, HandGroupStatechartContext, HandUnit, HandUnitConfigDialog, HandUnitDynamicSimulation, HandUnitSimulation, HapticObserver, HapticUnit, HeadIKUnit, HokuyoLaserUnit, HumanObstacleDetection, ImageProviderDynamicSimulation, ImageProviderGodotSimulation, ImageSourceSelection, ImageToPointCloud, IMUSimulation, IndexMemory, InertialMeasurementUnit, InertialMeasurementUnitObserver, InstallConditionExample, InterventionDebugger, InterventionObserver, JsonStorage, KBMComponent, KinematicSelfLocalization, KinematicUnit, KinematicUnitConfigDialog, KinematicUnitDynamicSimulation, KinematicUnitObserver, KinematicUnitSimulation, KITHandUnit, KITProstheticHandObserver, KITProstheticHandUnit, KLGImageProvider, LaserScannerSimulation, LaserScannerObstacleDetection, LaserScannerPointCloudProvider, LaserScannerSelfLocalisation, LaserScannerUnitObserver, LegacyRGBDOpenPoseEstimation, Component, Component, LocalizationUnit, LocalTimeServer, LogSpamTest, MaskFilterPointCloudProcessor, Component, MetaWearIMU, MetaWearIMUObserver, MMMPlayer, MMMPlayerConfigDialog, MMMSimulation, MotionControlGroupStatechartContext, MotionMemory, MotionPlanningServer, MotionPlanningServerConfigDialog, MultiHandUnit, MultiImageProvider, MultiSensePointCloudProvider, MultiViewPointCloudProcessor, NaturalGraspFilter, NaturalIKTest, Component, Component, Component, Component, Component, Component, Component, Component, Component, LaserScannerFeatureExtraction, Component, Component, Component, Component, Component, Component, Component, Component, NJointControllerBase, ObjectInstanceToIndex, ObjectLocalizationSaliency, ObjectLocalizerDynamicSimulation, ObjectMemoryEditor, ObjectPoseClientExample, ObjectPoseProviderExample, ObstacleAvoidingPlatformUnit, ObstacleAwarePlatformUnit, OpenCVImageStabilizer, OpenPoseEstimation, OpenPoseSimulation, OpossumLogger, OpticalFlow, OptoForce, OptoForceUnit, OptoForceUnitObserver, OrientedTactileSensorUnit, OrientedTactileSensorUnitObserver, PingLoadTest, PlannedMotionProvider, PlatformContext, PlatformUnit, PlatformUnitConfigDialog, PlatformUnitDynamicSimulation, PlatformUnitObserver, PlatformUnitSimulation, PointCloudRecorder, PointCloudUtility, PointCloudVisualizationConfigDialog, PrimitiveExtractionConfigDialog, PrimitiveExtractionParameterTuning, PrimitiveExtractor, PrimitiveVisualization, ProfilerObserver, PythonApplicationManager, RCImageProvider, ReflexCombination, RemoteGuiExample2, RemoteGuiProvider, RemoteObjectNode, RemoteState, RemoteStateOfferer< ContextType >, RemoteStateOfferer< FindAndGraspObjectContext >, RemoteStateOfferer< PlatformContext >, RemoteStateOfferer< StatechartContext >, ResultImageFuser, RGBDPoseEstimationWithMemoryWriter, VirtualRobotReaderExampleClient, Component, RobotControlUI, RobotDefinition, RobotHandLocalizationDynamicSimulation, RobotHealth, RobotHealthDummy, RobotIK, RobotNameService, RobotPoseUnit, RobotPoseUnitDynamicSimulation, RobotStatechartContext, RobotStateComponent, RobotStateObserver, RobotToArViz, ModuleBase, RobotUnitEmergencyStopMaster, RobotUnitObserver, RobotUnitSimulation, WorkerNode, RTABMapRegistration, SceneEditor, SceneModifier, SelfLocalizationDynamicSimulation, ShapesSupportRelations, SemanticGraphExample, SemanticGraphStorage, SemanticRelationAnalyzer, SimpleVirtualRobot, SimpleConfigDialog, SimpleEpisodicMemoryKinematicUnitConnector, SimpleEpisodicMemoryPlatformUnitConnector, SimpleGraspGenerator, SimpleRobotPlacement, SimpleStatechartExecutor, Component, Component, SimulationObjectPoseProvider, Simulator, SimulatorTimeServerProxy, SimulatorToArviz, SkillDashboard, BringObjectSkillProvider, GraspControlSkillProvider, HandControlSkillProvider, JointControlSkillProvider, PlatformControlSkillProvider, SkillProviderExample, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, SkillsMemory, SpeechObserver, StatechartEventDistributor, StatechartExecutorExample, StatechartListener, StatechartPerformanceTest, StateParameterExample, StateWatcher, StaticAgentReporter, StreamDecoderImageProvider, StreamImageProvider, StreamReceiver, SubjectMemory, SystemObserver, SystemStateMemory, TabletopSegmentation, TaskOutcomeMemory, TCPControllerSubUnit, TCPControlUnit, TCPControlUnitObserver, TCPMoverConfigDialog, ThreadList, TimeoutExample, TopicRecorderComponent, TopicReplayer, TopicTimingClient, TopicTimingServer, TrackingError, TrajectoryControllerSubUnit, TrajectoryPlayer, ValveAttention, ViconMarkerProvider, Component, Component, Component, Component, Component, ViewSelection, VirtualRobotWriterExample, MemoryGrapher, WorkingMemoryToArViz, XMLStateComponent, XsensIMU, SceneEditorConfigDialog, AbstractLongtermMemory, AbstractWorkingMemory, AgentAtPredicateProvider, ArmarXObjectsImporter, CommonPlacesLearner, CommonPlacesTester, CommonStorage, CommonStorageExample, EntityDrawerComponent, GraphNodePoseResolver, GraspablePredicateProvider, HandPredicateProvider, LongtermMemory, ObjectAtPredicateProvider, ObjectLocalizationMemoryUpdater, ObjectMemoryObserver, OnTablePredicateProvider, OnTopPredicateProvider, PriorEditorConfigDialog, PriorKnowledge, PriorKnowledgeImporter, ProfilerStorage, PutAwayLocationPredicateProvider, SimoxSceneImporter, SimpleEpisodicMemory, SimpleEpisodicMemoryWorkingMemoryConnector, WorkingMemory, WorkingMemoryExample, WorkingMemoryObjectPoseProvider, WorldStateObserver, XMLSceneImporter, WorkingMemoryController, Component, StreamProviderI, ViewSelectionConfigDialog, ArMarkerLocalizer, ArMarkerLocalizerOpenCV, ArMemToImageProvider, ArMemToPointCloudProvider, AzureKinectIRImageProvider, AzureKinectPointCloudProvider, BigBowlLocalization, BlobRecognition, CalibrationCreator2, CalibrationCreator, ColorMarkerObjectLocalizer, HumanActivityDebugger, HumanRobotInteractionDebugger, PersonInstanceUpdater, PersonMemoryDebugger, Component, PlaybackImageProvider, DeepFaceRecognition, Component, DummyArMarkerLocalizer, FakePointCloudProvider, HandMarkerLocalization, IEEE1394ImageProvider, ImagePassThrough, ImageSequenceProvider, ImageToArMem, Component, IntelRealSenseProvider, KinectAndCameraCalibration, KinectAndCameraCalibrationObserver, KinectV1PointCloudProvider, KinectV2PointCloudProvider, LabeledPointCloudMerger, LegacyRGBOpenPoseEstimation, MaskRCNNPointCloudObjectLocalizer, NerianVisionImageProvider, NerianVisionPointCloudProvider, NuitrackPointCloudProvider, ObjectLearningByPushing, ObjectLearningByPushingObserver, ObjectShapeClassification, OLPEvaluation, OpenNIImageProvider, OpenNIPointCloudProvider, Component, PointCloudFilter, PointCloudObjectLocalizer, PointCloudSegmenter, PointCloudToArMem, PointCloudToArViz, PointCloudVisualization, RCPointCloudProvider, ResultImageAndPointCloudProvider, ResultImageProvider, ResultPointCloudProvider, RGBDHandLocalizer, RGBDOpenPoseEstimation, RobotHandLocalizationWithFingertips, SegmentAABBShapesProvider, SegmentableObjectRecognition, SegmentableTemplateRecognition, SegmentRansacShapeExtractor, SegmentSpatialRelations, SimpleEpisodicMemoryImageConnector, SimpleEpisodicMemoryOpenPoseEstimationConnector, SimpleEpisodicMemorySemanticGraphConnector, StereoCameraProvider, StereoImagePointCloudProvider, TexturedObjectRecognition, UCLObjectRecognition, UserAssistedSegmenter, UserAssistedSegmenterConfigDialog, VideoFileImageProvider, VisualContactDetection, VisualContactDetectionObserver, VoxelGridMappingProvider, WebCamImageProvider, X11ScreenCaptureImageProvider, and Component.

◆ getIceManager()

IceManagerPtr getIceManager ( ) const

Returns the IceManager.

Returns
pointer to IceManager

◆ getMetaInfo()

VariantBasePtr getMetaInfo ( const std::string & id)

◆ getMetaInfoMap()

StringVariantBaseMap getMetaInfoMap ( ) const

◆ getName()

std::string getName ( ) const

Retrieve name of object.

Corresponds to well-known object name.

Returns
name

◆ getObjectAdapter()

Ice::ObjectAdapterPtr getObjectAdapter ( ) const

Returns object's Ice adapter.

Returns
object's adapter

◆ getObjectScheduler()

ArmarXObjectSchedulerPtr getObjectScheduler ( ) const

◆ GetObjectStateAsString()

std::string GetObjectStateAsString ( int state)
static

◆ getPeriodicTask()

ManagedIceObject::PeriodicTaskPtr getPeriodicTask ( const std::string & name)

◆ getPluginPointer()

std::unique_ptr< ManagedIceObjectPlugin > & getPluginPointer ( std::type_info const & type,
std::string const & prefix )
protected

◆ getProfiler()

Profiler::ProfilerPtr getProfiler ( ) const

getProfiler returns an instance of armarx::Profiler

◆ getProxy() [1/9]

template<class ProxyTarg, class... Args>
void getProxy ( const char * name,
IceInternal::ProxyHandle< ProxyTarg > & proxy,
Args &&... args )
inline

◆ getProxy() [2/9]

template<class ProxyType>
ProxyType getProxy ( const std::string & name,
bool addToDependencies = false,
const std::string & endpoints = "",
bool throwOnProxyError = true )
inline

Retrieves a proxy object.

Parameters
nameProxy name, e.g. Log
addToDependenciesIf true, this proxy is added to the dependency list and this function won't return until the proxy becomes available.
endpointsThe endpoints, e.g. tcp ‑p 10002
throwOnProxyErrorIf true, throws Exception on any proxy error. If false, just returns zero pointer.
Exceptions
LocalExceptionThrows if proxy is not available, this object is not yet starting or the proxyName is empty.
Returns
A proxy of the remote instance.

◆ getProxy() [3/9]

template<class ProxyTarg, class... Args>
void getProxy ( const std::string & name,
IceInternal::ProxyHandle< ProxyTarg > & proxy,
Args &&... args )
inline

◆ getProxy() [4/9]

template<class ProxyTarg, class... Args>
void getProxy ( IceInternal::ProxyHandle< ProxyTarg > & proxy,
const char * name,
Args &&... args )
inline

◆ getProxy() [5/9]

template<class ProxyTarg, class... Args>
void getProxy ( IceInternal::ProxyHandle< ProxyTarg > & proxy,
const std::string & name,
Args &&... args )
inline

Assigns a proxy to proxy.

This method can be called without explicit template argument, as the proxy type can be inferred from the arguments.

See also
getProxy<>()

◆ getProxy() [6/9]

Ice::ObjectPrx getProxy ( long timeoutMs = 0,
bool waitForScheduler = true ) const

Returns the proxy of this object (optionally it waits for the proxy)

Parameters
timeoutMsTimeout in miliseconds until this function stops waiting for the proxy. Set to -1 for infinite waiting.
Returns
object's proxy (will be null if the time runs out/no object scheduler was set (e.g. by calling addObject on an ArmarXManager))

◆ getProxy() [7/9]

template<class Prx>
Prx getProxy ( long timeoutMs = 0,
bool waitForScheduler = true ) const
inline

◆ getProxy() [8/9]

template<class ProxyType>
void getProxy ( ProxyType & proxy,
const char * name,
bool addToDependencies = false,
const std::string & endpoints = "",
bool throwOnProxyError = true )
inline

Overload to allow using string literals as name (solve ambiguous overload).

◆ getProxy() [9/9]

template<class Prx>
void getProxy ( Prx & prx,
long timeoutMs = 0,
bool waitForScheduler = true ) const
inline

◆ getState()

int getState ( ) const

Retrieve current state of the ManagedIceObject.

Returns
state of the ManagedIceObject

◆ getTopic() [1/2]

template<class TopicProxyType>
TopicProxyType getTopic ( const std::string & name)
inline

Returns a proxy of the specified topic.

Parameters
nameTopic name
Returns
Topic proxy of the type TopicProxyType

◆ getTopic() [2/2]

template<class TopicProxyType>
void getTopic ( TopicProxyType & topicProxy,
const std::string & name )
inline

Assigns a proxy of the specified topic to topicProxy.

This method can be called without explicit template argument, as the topic proxy type can be inferred from the arguments.

Parameters
topicProxyThe topic proxy to be assigned.
nameTopic name
See also
getTopic<>()

◆ getUnresolvedDependencies()

std::vector< std::string > getUnresolvedDependencies ( ) const

returns the names of all unresolved dependencies

◆ offeringTopic()

void offeringTopic ( const std::string & name)

Registers a topic for retrival after initialization.

Parameters
nameTopic name

◆ onConnectComponent()

virtual void onConnectComponent ( )
protectedpure virtual

Pure virtual hook for the subclass.

Is called once all dependencies of the object have been resolved and Ice connection is established. This hook is called whenever the dependencies are found. That means if the a depedency crashes or shuts down, the ManagedIceObject goes into disconnected state. When the dependencies are found again, this hook is called again.

See also
onDisconnectComponent()

Implemented in ik_demo, ManagerNode, WorkerNode, AffordanceExtraction, AffordancePipelineGuiConfigDialog, AffordancePipelineGuiWidgetController, AffordancePipelineVisualization, AffordanceUpdateListener, ArMarkerExternalCameraCalibration, ArmarXFileLogger, ArmarXPhysicsWorldVisualization, ArmarXPlotter, ArmarXSimulatorWindow, ArmarXTimeserver, ProprioceptionStressTest, LegacyRobotStateMemoryAdapter, MemoryNameSystem, GraspMemory, HumanMemory, LaserScansMemory, ObjectMemory, ReasoningMemory, RobotStateMemory, VisionMemory, ArMemMemoryViewerWidgetController, AronComponentConfigExample, ArticulatedObjectLocalizerExample, ArticulatedObjectLocalizerDynamicSimulation, ArVizDrawerGuiWidgetController, ArVizExample, ArVizInteractExample, ArVizStorage, ArVizWidgetController, ATINetFTUnit, BatteryWidget, BoxToGraspCandidatesWidgetController, CartesianImpedanceControllerWidgetController, CartesianNaturalPositionControllerWidgetController, CartesianWaypointControlGuiWidgetController, ClockWidgetController, ClutteredSceneGeneratorWidgetController, CoFusionProcessor, CollisionCheckerComponent, TaskOutcomeDebugger, ConditionHandler, ConditionViewerWidgetController, Component, Component, Component, Component, Component, Component, Component, Component, Component, DebugDrawerComponent, DebugDrawerGuiPluginWidgetController, DebugDrawerToArVizComponent, DebugDrawerViewerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, DemoStateManager, DepthImageProviderDynamicSimulation, Base, Receiver, DHParameterOptimizationLogger, DiagnosticsSubUnit, DMPComponent, DSObstacleAvoidance, DummyAgentReporter, DummyObjectLocalizer, DummyTextToSpeech, DummyWorldStateObserver, DynamicObstacleManager, DynamicRemoteState, EmergencyStopMaster, EmergencyStopNode< T >, EmergencyStopWidget, EventSenderOverview, ExampleMemory, ExampleMemoryClient, ExternalApplicationManager, ExternalApplicationManagerDependency, ExternalApplicationManagerStarter, FakeObjectDetector, FakeWorkingMemoryObjectLocalizer, FamiliarObjectDetectionExample, ForceTorqueUnit, FrameTracking, FTSensorCalibrationGuiWidgetController, FunctionApproximator, GamepadControlUnit, GamepadUnit, GeneralPurposeMemory, GraspCandidateViewerWidgetController, GraspingManager, GraspProviderExample, GraspSelectionCriterionBase, GraspSelectionManager, GridFSFileEditorWidgetController, GuiHealthClientWidgetController, HandUnit, HandUnitConfigDialog, HandUnitWidget, HapticUnit, HapticUnitWidget, HeadIKUnit, HokuyoLaserUnit, HomogeneousMatrixCalculatorWidgetController, HumanObstacleDetection, IceGridViewer, IceProxyWidgetController, ImageToPointCloud, IndexMemory, InertialMeasurementUnit, InterventionDebugger, InterventionObserver, JsonStorage, KBMComponent, KinematicSelfLocalization, KinematicUnit, KinematicUnitConfigDialog, KinematicUnitWidgetController, KITProstheticHandObserver, LaserScannerSimulation, LaserScannerObstacleDetection, LaserScannerPluginWidgetController, LaserScannerSelfLocalisation, LaserScannerSelfLocalisationWidgetController, LoadObjectsIntoMemoryWidgetController, Component, Component, SelfLocalization, LocalizationUnit, LocalTimeServer, LogSpamTest, LogViewer, Component, MessageDisplayPluginWidgetController, MetaWearIMU, MMMPlayer, MMMPlayerConfigDialog, MMMPlayerWidget, MMMSimulation, MotionMemory, MotionPlanningServer, MotionPlanningServerConfigDialog, MotionPlanningServerWidgetController, MultiHandUnit, MultiSensePointCloudProvider, NaturalIKTest, Component, Component, Component, Component, Component, Component, Component, Component, Component, LaserScannerFeatureExtraction, Component, Component, Component, Component, Component, Component, Component, Component, WidgetController, NJointControllerBase, ObjectInstanceToIndex, ObjectLocalizationRequesterWidgetController, ObjectLocalizationSaliency, ObjectLocalizerDynamicSimulation, ObjectMemoryEditor, ObjectPoseClientExample, ObjectPoseGuiWidgetController, ObjectPoseProviderExample, ObserverWidgetController, OpenPoseSimulation, OperatorViewWidgetController, OpossumLogger, OptoForce, OptoForceUnit, OrientedTactileSensorUnit, PathPlanner, PingLoadTest, PlannedMotionProvider, PlatformUnit, PlatformUnitConfigDialog, PlatformUnitWidget, PointCloudUtility, PointCloudVisualizationConfigDialog, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionConfigDialog, PrimitiveExtractionWidgetController, PrimitiveVisualization, PythonApplicationManager, ReflexCombination, RemoteGuiExample2, RemoteGuiProvider, RemoteGuiWidgetController, RemoteObjectNode, RemoteState, VirtualRobotReaderExampleClient, Component, RobotControlUI, RobotDefinition, RobotHandLocalizationDynamicSimulation, RobotHealth, RobotHealthDummy, RobotIK, RobotIKWidgetController, RobotNameService, RobotPoseUnit, RobotStateComponent, RobotToArViz, RobotTrajectoryDesignerGuiPluginWidgetController, ModuleBase, RobotUnitEmergencyStopMaster, RobotUnitPluginWidgetController, RobotViewerWidgetController, WorkerNode, RTABMapRegistration, ScenarioManagerWidgetController, SceneEditor, SceneModifier, SelfLocalization, SelfLocalizationDynamicSimulation, ShapesSupportRelations, SemanticGraphExample, SemanticGraphStorage, SemanticRelationAnalyzer, SemanticRelationViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SimpleVirtualRobot, SimpleConfigDialog, SimpleEpisodicMemoryKinematicUnitConnector, SimpleEpisodicMemoryPlatformUnitConnector, SimpleGraspGenerator, SimpleRobotPlacement, SimpleStatechartExecutor, Component, Component, SimulationObjectPoseProvider, Simulator, SimulatorControlController, SimulatorTimeServerProxy, SimulatorToArviz, SkillDashboard, SkillDashboardWidget, SkillManagerMonitorWidgetController, BringObjectSkillProvider, GraspControlSkillProvider, HandControlSkillProvider, JointControlSkillProvider, PlatformControlSkillProvider, SkillProviderExample, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, SkillsMemory, SnapshotControlWidgetController, StatechartEditorController, StatechartExecutorExample, StatechartListener, StatechartViewerController, StateWatcher, StaticAgentReporter, StaticPlotterWidgetController, StreamDecoderImageProvider, StreamImageProvider, StreamReceiver, SubjectMemory, SystemStateMemory, SystemStateMonitorWidget, TaskOutcomeMemory, TCPControllerSubUnit, TCPControlUnit, TCPMover, TCPMoverConfigDialog, ThreadList, ThreadViewer, TopicRecorderComponent, TopicReplayer, TopicReplayerWidgetController, TopicTimingClient, TopicTimingServer, TrajectoryControllerSubUnit, TrajectoryPlayer, ViconMarkerProvider, Component, Component, Component, Component, Component, Viewer3DWidget, ViewSelection, ViewSelectionWidgetController, VirtualRobotWriterExample, MemoryGrapher, WidgetController, WorkingMemoryToArViz, WriteToDebugObserverGuiPluginWidgetController, XMLStateComponent, SceneEditorConfigDialog, SceneEditorMainWindowController, AbstractLongtermMemory, AbstractWorkingMemory, ArmarXObjectsImporter, CommonPlacesLearner, CommonPlacesTester, CommonStorage, CommonStorageExample, EntityDrawerComponent, GraphNodePoseResolver, GraphVisualizerWidget, ObjectLocalizationMemoryUpdater, PriorEditorConfigDialog, PriorEditorController, PriorKnowledge, PriorKnowledgeImporter, ProfilerStorage, SimoxSceneImporter, SimpleEpisodicMemory, SimpleEpisodicMemoryWorkingMemoryConnector, WorkingMemoryController, WorkingMemoryExample, WorkingMemoryObjectPoseProvider, WorkingMemoryUpdater, WorldStateObserver, WorldStateUpdaterBase, XMLSceneImporter, WorkingMemoryController, Component, ViewSelectionConfigDialog, ArMemToImageProvider, AzureKinectPointCloudProvider, HumanActivityDebugger, HumanRobotInteractionDebugger, PersonInstanceUpdater, PersonMemoryDebugger, Component, DeepFaceRecognition, DummyArMarkerLocalizer, FakePointCloudProvider, ImagePassThrough, ImageProcessor, ImageProvider, ImageRecorderWidgetController, Component, IntelRealSenseProvider, KinectV1PointCloudProvider, KinectV2PointCloudProvider, NerianVisionPointCloudProvider, NuitrackPointCloudProvider, ObjectShapeClassification, OLPEvaluation, OpenNIPointCloudProvider, Component, PointCloudAndImageProcessor, PointCloudAndImageProvider, PointCloudProcessor, PointCloudProvider, RCPointCloudProvider, ResultImageAndPointCloudProvider, SimpleEpisodicMemoryOpenPoseEstimationConnector, SimpleEpisodicMemorySemanticGraphConnector, StereoImagePointCloudProvider, UCLObjectRecognition, UserAssistedSegmenterConfigDialog, and UserAssistedSegmenterGuiWidgetController.

◆ onDisconnectComponent()

virtual void onDisconnectComponent ( )
inlineprotectedvirtual

Hook for subclass.

Is called if a dependency of the object got lost (crash, network error, stopped, ...). This hook should be the inverse to onConnectComponent(). So that onDisconnectComponent() and onConnectComponent() can be called alternatingly and the ManagedIceObject remains in valid states. *

See also
onConnectComponent

Reimplemented in ik_demo, ManagerNode, WorkerNode, AffordanceExtraction, AffordancePipelineGuiWidgetController, AffordancePipelineVisualization, AffordanceUpdateListener, ArMarkerExternalCameraCalibration, ArmarXFileLogger, ArmarXPhysicsWorldVisualization, ArmarXSimulatorWindow, ArmarXTimeserver, ProprioceptionStressTest, LegacyRobotStateMemoryAdapter, MemoryNameSystem, GraspMemory, HumanMemory, LaserScansMemory, ObjectMemory, ReasoningMemory, RobotStateMemory, VisionMemory, ArMemMemoryViewerWidgetController, AronComponentConfigExample, ArticulatedObjectLocalizerExample, ArticulatedObjectLocalizerDynamicSimulation, ArVizDrawerGuiWidgetController, ArVizExample, ArVizInteractExample, ArVizStorage, ArVizWidgetController, ATINetFTUnit, BatteryWidget, CartesianNaturalPositionControllerWidgetController, ClockWidgetController, CoFusionProcessor, CollisionCheckerComponent, TaskOutcomeDebugger, ConditionViewerWidgetController, Component, Component, Component, Component, Component, Component, Component, Component, Component, DebugDrawerComponent, DebugDrawerGuiPluginWidgetController, DebugDrawerToArVizComponent, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, DemoStateManager, DepthImageProviderDynamicSimulation, Base, DHParameterOptimizationLogger, DMPComponent, DSObstacleAvoidance, DummyAgentReporter, DummyObjectLocalizer, DummyTextToSpeech, DummyWorldStateObserver, DynamicObstacleManager, EmergencyStopWidget, ExampleMemory, ExampleMemoryClient, ExternalApplicationManager, ExternalApplicationManagerDependency, ExternalApplicationManagerStarter, FakeObjectDetector, FakeWorkingMemoryObjectLocalizer, FamiliarObjectDetectionExample, ForceTorqueObserver, FrameTracking, FTSensorCalibrationGuiWidgetController, FunctionApproximator, GamepadControlUnit, GamepadUnit, GeneralPurposeMemory, GraspCandidateViewerWidgetController, GraspingManager, GraspProviderExample, GridFSFileEditorWidgetController, GuiHealthClientWidgetController, HandUnitWidget, HapticUnitWidget, HeadIKUnit, HokuyoLaserUnit, HumanObstacleDetection, ImageToPointCloud, IndexMemory, InertialMeasurementUnit, InterventionDebugger, InterventionObserver, JsonStorage, KBMComponent, KinematicSelfLocalization, KinematicUnitWidgetController, KITProstheticHandObserver, LaserScannerSimulation, LaserScannerObstacleDetection, LaserScannerSelfLocalisation, Component, Component, SelfLocalization, LocalTimeServer, LogSpamTest, Component, MetaWearIMU, MMMPlayer, MMMPlayerWidget, MMMSimulation, MotionMemory, MotionPlanningServer, MotionPlanningServerWidgetController, MultiHandUnit, MultiSensePointCloudProvider, NaturalIKTest, Component, Component, Component, Component, Component, Component, Component, Component, Component, LaserScannerFeatureExtraction, Component, Component, Component, Component, Component, Component, Component, Component, NJointBimanualCCDMPController, NJointControllerBase, ObjectInstanceToIndex, ObjectLocalizationRequesterWidgetController, ObjectLocalizationSaliency, ObjectLocalizerDynamicSimulation, ObjectMemoryEditor, ObjectPoseClientExample, ObjectPoseGuiWidgetController, ObjectPoseProviderExample, OpenPoseSimulation, OperatorViewWidgetController, OpossumLogger, OptoForce, OptoForceUnit, PingLoadTest, PlannedMotionProvider, PlatformUnit, PlatformUnitWidget, PointCloudUtility, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionWidgetController, PrimitiveVisualization, PythonApplicationManager, ReflexCombination, RemoteGuiExample2, RemoteGuiProvider, RemoteState, VirtualRobotReaderExampleClient, Component, RobotDefinition, RobotHandLocalizationDynamicSimulation, RobotHealth, RobotHealthDummy, RobotIK, RobotIKWidgetController, RobotNameService, RobotPoseUnit, RobotStateComponent, RobotToArViz, RobotTrajectoryDesignerGuiPluginWidgetController, ModuleBase, RobotUnitPluginWidgetController, RobotViewerWidgetController, RTABMapRegistration, SceneEditor, SceneModifier, SelfLocalization, SelfLocalizationDynamicSimulation, ShapesSupportRelations, SemanticGraphExample, SemanticGraphStorage, SemanticRelationAnalyzer, SemanticRelationViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SimpleVirtualRobot, SimpleEpisodicMemoryKinematicUnitConnector, SimpleEpisodicMemoryPlatformUnitConnector, SimpleGraspGenerator, SimpleRobotPlacement, Component, Component, SimulationObjectPoseProvider, Simulator, SimulatorControlController, SimulatorTimeServerProxy, SimulatorToArviz, SkillDashboard, SkillDashboardWidget, SkillManagerMonitorWidgetController, BringObjectSkillProvider, GraspControlSkillProvider, HandControlSkillProvider, JointControlSkillProvider, PlatformControlSkillProvider, SkillProviderExample, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, SkillsMemory, SnapshotControlWidgetController, StatechartEditorController, StatechartExecutorExample, StatechartViewerController, StateWatcher, StaticAgentReporter, StreamReceiver, SubjectMemory, SystemStateMemory, SystemStateMonitorWidget, TaskOutcomeMemory, TCPControlUnit, ThreadList, TopicRecorderComponent, TopicReplayer, TopicTimingClient, TopicTimingServer, TrajectoryControllerSubUnit, TrajectoryPlayer, ViconMarkerProvider, Component, Component, Component, Component, Component, ViewSelection, VirtualRobotWriterExample, MemoryGrapher, WeissHapticUnit, WorkingMemoryToArViz, XMLStateComponent, SceneEditorMainWindowController, ArmarXObjectsImporter, EntityDrawerComponent, GraphNodePoseResolver, ObjectLocalizationMemoryUpdater, PriorEditorController, ProfilerStorage, SimpleEpisodicMemory, SimpleEpisodicMemoryWorkingMemoryConnector, WorkingMemoryController, WorkingMemoryObjectPoseProvider, WorkingMemoryUpdater, Component, ArMemToImageProvider, AzureKinectPointCloudProvider, HumanActivityDebugger, HumanRobotInteractionDebugger, PersonInstanceUpdater, PersonMemoryDebugger, Component, DummyArMarkerLocalizer, FakePointCloudProvider, ImagePassThrough, ImageProcessor, ImageProvider, ImageRecorderWidgetController, Component, IntelRealSenseProvider, KinectV1PointCloudProvider, KinectV2PointCloudProvider, NerianVisionPointCloudProvider, NuitrackPointCloudProvider, ObjectLocalizerProcessor, OLPEvaluation, OpenNIPointCloudProvider, Component, PointCloudAndImageProcessor, PointCloudAndImageProvider, PointCloudProcessor, PointCloudProvider, RCPointCloudProvider, ResultImageAndPointCloudProvider, SimpleEpisodicMemorySemanticGraphConnector, and StereoImagePointCloudProvider.

◆ onExitComponent()

virtual void onExitComponent ( )
inlineprotectedvirtual

Hook for subclass.

Is called once the component terminates. Use for cleanup. Only called once.

Reimplemented in ik_demo, ManagerNode, WorkerNode, AffordanceExtraction, AffordancePipelineGuiConfigDialog, AffordancePipelineVisualization, AffordanceUpdateListener, ArMarkerExternalCameraCalibration, ArmarXFileLogger, ArmarXPhysicsWorldVisualization, ArmarXPlotter, ArmarXSimulatorWindow, ArmarXTimeserver, ProprioceptionStressTest, LegacyRobotStateMemoryAdapter, MemoryNameSystem, GraspMemory, HumanMemory, LaserScansMemory, ObjectMemory, ReasoningMemory, RobotStateMemory, VisionMemory, AronComponentConfigExample, ArticulatedObjectLocalizerExample, ArticulatedObjectLocalizerDynamicSimulation, ArVizExample, ArVizInteractExample, ArVizStorage, ArVizWidgetController, ATINetFTUnit, CoFusionProcessor, CollisionCheckerComponent, TaskOutcomeDebugger, ConditionViewerWidgetController, Component, Component, Component, Component, Component, Component, Component, Component, Component, DebugDrawerComponent, DebugDrawerToArVizComponent, DebugDrawerViewerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, DemoStateManager, DepthImageProviderDynamicSimulation, Base, Receiver, DHParameterOptimizationLogger, DMPComponent, DSObstacleAvoidance, DummyAgentReporter, DummyObjectLocalizer, DummyTextToSpeech, DummyWorldStateObserver, DynamicObstacleManager, ExampleMemory, ExampleMemoryClient, ExternalApplicationManager, ExternalApplicationManagerDependency, ExternalApplicationManagerStarter, FakeObjectDetector, FakeWorkingMemoryObjectLocalizer, FamiliarObjectDetectionExample, ForceTorqueUnit, FrameTracking, FTSensorCalibrationGuiWidgetController, FunctionApproximator, GamepadControlUnit, GamepadUnit, GeneralPurposeMemory, GraspCandidateViewerWidgetController, GraspingManager, GraspProviderExample, HandUnit, HandUnitWidget, HapticUnit, HapticUnitWidget, HeadIKUnit, HokuyoLaserUnit, HumanObstacleDetection, IceGridViewer, ImageToPointCloud, IndexMemory, InertialMeasurementUnit, InterventionDebugger, InterventionObserver, JsonStorage, KBMComponent, KinematicSelfLocalization, KinematicUnit, KinematicUnitConfigDialog, KinematicUnitWidgetController, KITProstheticHandObserver, LaserScannerSimulation, LaserScannerObstacleDetection, LaserScannerSelfLocalisation, Component, Component, SelfLocalization, LogSpamTest, LogViewer, Component, MetaWearIMU, MMMPlayer, MMMPlayerConfigDialog, MMMPlayerWidget, MMMSimulation, MotionMemory, MotionPlanningServer, MultiHandUnit, MultiSensePointCloudProvider, NaturalIKTest, Component, Component, Component, Component, Component, Component, Component, Component, Component, LaserScannerFeatureExtraction, Component, Component, Component, Component, Component, Component, Component, Component, NJointControllerBase, ObjectInstanceToIndex, ObjectLocalizationSaliency, ObjectLocalizerDynamicSimulation, ObjectMemoryEditor, ObjectPoseClientExample, ObjectPoseProviderExample, ObserverWidgetController, OpenPoseSimulation, OperatorViewWidgetController, OpossumLogger, OptoForce, OptoForceUnit, PingLoadTest, PlannedMotionProvider, PlatformUnit, PlatformUnitWidget, PointCloudUtility, PointCloudVisualizationConfigDialog, PresenterViewWidgetController, PrimitiveExtractionConfigDialog, PrimitiveVisualization, PythonApplicationManager, ReflexCombination, RemoteGuiExample2, RemoteGuiProvider, RemoteObjectNode, VirtualRobotReaderExampleClient, Component, RobotControlUI, RobotDefinition, RobotHandLocalizationDynamicSimulation, RobotHealth, RobotHealthDummy, RobotIKWidgetController, RobotNameService, RobotPoseUnit, RobotToArViz, ModuleBase, RobotUnitPluginWidgetController, RobotViewerWidgetController, WorkerNode, RTABMapRegistration, ScenarioManagerWidgetController, SceneEditor, SceneModifier, SelfLocalization, ShapesSupportRelations, SemanticGraphExample, SemanticGraphStorage, SemanticRelationAnalyzer, SensorActorUnit, SimoxCSpaceVisualizerWidgetController, SimpleVirtualRobot, SimpleEpisodicMemoryKinematicUnitConnector, SimpleEpisodicMemoryPlatformUnitConnector, SimpleGraspGenerator, SimpleRobotPlacement, SimpleStatechartExecutor, Component, Component, SimulationObjectPoseProvider, Simulator, SimulatorControlController, SimulatorTimeServerProxy, SimulatorToArviz, SkillDashboard, SkillDashboardWidget, BringObjectSkillProvider, GraspControlSkillProvider, HandControlSkillProvider, JointControlSkillProvider, PlatformControlSkillProvider, SkillProviderExample, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, SkillsMemory, StatechartEditorController, StatechartExecutorExample, StatechartViewerController, StaticAgentReporter, StreamReceiver, SubjectMemory, SystemStateMemory, SystemStateMonitorWidget, TaskOutcomeMemory, TCPControlUnit, TCPMover, ThreadViewer, TopicRecorderComponent, TopicTimingClient, TopicTimingServer, TrajectoryPlayer, ViconMarkerProvider, Component, Component, Component, Component, Component, ViewSelection, VirtualRobotWriterExample, MemoryGrapher, WorkingMemoryToArViz, SceneEditorConfigDialog, ArmarXObjectsImporter, CommonPlacesLearner, CommonStorage, EntityDrawerComponent, GraphNodePoseResolver, GraphVisualizerWidget, PriorEditorController, ProfilerStorage, SimpleEpisodicMemory, SimpleEpisodicMemoryWorkingMemoryConnector, WorkingMemoryController, WorkingMemoryObjectPoseProvider, WorkingMemoryUpdater, Component, ViewSelectionConfigDialog, ArMemToImageProvider, AzureKinectPointCloudProvider, HumanActivityDebugger, HumanRobotInteractionDebugger, PersonInstanceUpdater, PersonMemoryDebugger, Component, DummyArMarkerLocalizer, FakePointCloudProvider, ImagePassThrough, ImageProcessor, ImageProvider, ImageRecorderWidgetController, Component, IntelRealSenseProvider, KinectV1PointCloudProvider, KinectV2PointCloudProvider, NerianVisionPointCloudProvider, NuitrackPointCloudProvider, OLPEvaluation, OpenNIPointCloudProvider, Component, PointCloudAndImageProcessor, PointCloudAndImageProvider, PointCloudProcessor, PointCloudProvider, RCPointCloudProvider, ResultImageAndPointCloudProvider, SimpleEpisodicMemorySemanticGraphConnector, StereoImagePointCloudProvider, and UserAssistedSegmenterConfigDialog.

◆ onInitComponent()

virtual void onInitComponent ( )
protectedpure virtual

Pure virtual hook for the subclass.

Is called once initialization of the ManagedIceObject is done. This hook is called in the implenting class once and never again during the lifecyle of the object. This function is called as soon as the ManagedIceObject was added to the ArmarXManager. Called in an own thread and not the thread it was created in.

Implemented in ik_demo, ManagerNode, WorkerNode, AffordanceExtraction, AffordancePipelineGuiConfigDialog, AffordancePipelineGuiWidgetController, AffordancePipelineVisualization, AffordanceUpdateListener, ArMarkerExternalCameraCalibration, ArmarXFileLogger, ArmarXPhysicsWorldVisualization, ArmarXPlotter, ArmarXSimulatorWindow, ArmarXTimeserver, ProprioceptionStressTest, LegacyRobotStateMemoryAdapter, MemoryNameSystem, GraspMemory, HumanMemory, LaserScansMemory, ObjectMemory, ReasoningMemory, RobotStateMemory, VisionMemory, ArMemMemoryViewerWidgetController, AronComponentConfigExample, ArticulatedObjectLocalizerExample, ArticulatedObjectLocalizerDynamicSimulation, ArVizDrawerGuiWidgetController, ArVizExample, ArVizInteractExample, ArVizStorage, ArVizWidgetController, ATINetFTUnit, BatteryWidget, BoxToGraspCandidatesWidgetController, CartesianNaturalPositionControllerWidgetController, ClockWidgetController, ClutteredSceneGeneratorWidgetController, CoFusionProcessor, CollisionCheckerComponent, TaskOutcomeDebugger, ConditionHandler, ConditionViewerWidgetController, Component, Component, Component, Component, Component, Component, Component, Component, Component, DebugDrawerComponent, DebugDrawerGuiPluginWidgetController, DebugDrawerToArVizComponent, DebugDrawerViewerWidgetController, DebugPlotterWidgetWidgetController, DebugRobotUnitDataStreamingWidgetController, DemoStateManager, DepthImageProviderDynamicSimulation, Base, Receiver, DHParameterOptimizationLogger, DiagnosticsSubUnit, DMPComponent, DSObstacleAvoidance, DummyAgentReporter, DummyObjectLocalizer, DummyTextToSpeech, DummyWorldStateObserver, DynamicObstacleManager, DynamicRemoteState, EmergencyStopMaster, EmergencyStopNode< T >, EmergencyStopWidget, EventSenderOverview, ExampleMemory, ExampleMemoryClient, ExternalApplicationManager, ExternalApplicationManagerDependency, ExternalApplicationManagerStarter, FakeObjectDetector, FakeWorkingMemoryObjectLocalizer, FamiliarObjectDetectionExample, ForceTorqueUnit, FrameTracking, FTSensorCalibrationGuiWidgetController, FunctionApproximator, GamepadControlUnit, GamepadUnit, GeneralPurposeMemory, GraspCandidateViewerWidgetController, GraspingManager, GraspProviderExample, GraspSelectionCriterionBase, GraspSelectionManager, GridFSFileEditorWidgetController, GuiHealthClientWidgetController, HandUnit, HandUnitConfigDialog, HandUnitWidget, HapticUnit, HapticUnitWidget, HeadIKUnit, HokuyoLaserUnit, HomogeneousMatrixCalculatorWidgetController, HumanObstacleDetection, IceGridViewer, IceProxyWidgetController, ImageToPointCloud, IndexMemory, InertialMeasurementUnit, InterventionDebugger, InterventionObserver, JsonStorage, KBMComponent, KinematicSelfLocalization, KinematicUnit, KinematicUnitConfigDialog, KinematicUnitWidgetController, KITProstheticHandObserver, LaserScannerSimulation, LaserScannerObstacleDetection, LaserScannerPluginWidgetController, LaserScannerSelfLocalisation, LaserScannerSelfLocalisationWidgetController, LoadObjectsIntoMemoryWidgetController, Component, Component, SelfLocalization, LocalizationUnit, LocalTimeServer, LogSpamTest, LogViewer, Component, MessageDisplayPluginWidgetController, MetaWearIMU, MMMPlayer, MMMPlayerConfigDialog, MMMPlayerWidget, MMMSimulation, MotionMemory, MotionPlanningServer, MotionPlanningServerConfigDialog, MotionPlanningServerWidgetController, MultiHandUnit, MultiSensePointCloudProvider, NaturalIKTest, Component, Component, Component, Component, Component, Component, Component, Component, Component, LaserScannerFeatureExtraction, Component, Component, Component, Component, Component, Component, Component, Component, WidgetController, NJointBimanualCCDMPController, NJointControllerBase, ObjectInstanceToIndex, ObjectLocalizationRequesterWidgetController, ObjectLocalizationSaliency, ObjectLocalizerDynamicSimulation, ObjectMemoryEditor, ObjectPoseClientExample, ObjectPoseGuiWidgetController, ObjectPoseProviderExample, ObserverWidgetController, OpenPoseSimulation, OperatorViewWidgetController, OpossumLogger, OptoForce, OptoForceUnit, OrientedTactileSensorUnit, PathPlanner, PingLoadTest, PlannedMotionProvider, PlatformUnit, PlatformUnitConfigDialog, PlatformUnitWidget, PointCloudUtility, PointCloudVisualizationConfigDialog, PointCloudVisualizationWidgetController, PresenterViewWidgetController, PrimitiveExtractionConfigDialog, PrimitiveExtractionWidgetController, PrimitiveVisualization, PythonApplicationManager, ReflexCombination, RemoteGuiExample2, RemoteGuiProvider, RemoteGuiWidgetController, RemoteObjectNode, RemoteState, VirtualRobotReaderExampleClient, Component, RobotControlUI, RobotDefinition, RobotHandLocalizationDynamicSimulation, RobotHealth, RobotHealthDummy, RobotIK, RobotIKWidgetController, RobotNameService, RobotPoseUnit, RobotStateComponent, RobotToArViz, RobotTrajectoryDesignerGuiPluginWidgetController, ModuleBase, RobotUnitEmergencyStopMaster, RobotUnitPluginWidgetController, RobotViewerWidgetController, WorkerNode, RTABMapRegistration, ScenarioManagerWidgetController, SceneEditor, SceneModifier, SelfLocalization, ShapesSupportRelations, SemanticGraphExample, SemanticGraphStorage, SemanticRelationAnalyzer, SemanticRelationViewerWidgetController, SimoxCSpaceVisualizerWidgetController, SimpleVirtualRobot, SimpleConfigDialog, SimpleEpisodicMemoryKinematicUnitConnector, SimpleEpisodicMemoryPlatformUnitConnector, SimpleGraspGenerator, SimpleRobotPlacement, SimpleStatechartExecutor, Component, Component, SimulationObjectPoseProvider, Simulator, SimulatorControlController, SimulatorTimeServerProxy, SimulatorToArviz, SkillDashboard, SkillDashboardWidget, SkillManagerMonitorWidgetController, BringObjectSkillProvider, GraspControlSkillProvider, HandControlSkillProvider, JointControlSkillProvider, PlatformControlSkillProvider, SkillProviderExample, TCPControlSkillProvider, VisualSearchSkillProvider, VisualServoTCPControlSkillProvider, SkillsMemory, SnapshotControlWidgetController, StatechartEditorController, StatechartExecutorExample, StatechartListener, StatechartViewerController, StateWatcher, StaticAgentReporter, StaticPlotterWidgetController, StreamReceiver, SubjectMemory, SystemStateMemory, SystemStateMonitorWidget, TaskOutcomeMemory, TCPControllerSubUnit, TCPControlUnit, TCPMover, TCPMoverConfigDialog, ThreadList, ThreadViewer, TopicRecorderComponent, TopicReplayer, TopicReplayerWidgetController, TopicTimingClient, TopicTimingServer, TrajectoryControllerSubUnit, TrajectoryPlayer, ViconMarkerProvider, Component, Component, Component, Component, Component, Viewer3DWidget, ViewSelection, ViewSelectionWidgetController, VirtualRobotWriterExample, MemoryGrapher, WidgetController, WorkingMemoryToArViz, WriteToDebugObserverGuiPluginWidgetController, XMLStateComponent, SceneEditorConfigDialog, SceneEditorMainWindowController, AbstractLongtermMemory, AbstractWorkingMemory, ArmarXObjectsImporter, CommonPlacesLearner, CommonPlacesTester, CommonStorage, CommonStorageExample, EntityDrawerComponent, GraphNodePoseResolver, GraphVisualizerWidget, ObjectLocalizationMemoryUpdater, PriorEditorConfigDialog, PriorEditorController, PriorKnowledge, PriorKnowledgeImporter, ProfilerStorage, SimoxSceneImporter, SimpleEpisodicMemory, SimpleEpisodicMemoryWorkingMemoryConnector, WorkingMemoryController, WorkingMemoryExample, WorkingMemoryObjectPoseProvider, WorkingMemoryUpdater, WorldStateObserver, WorldStateUpdaterBase, XMLSceneImporter, WorkingMemoryController, Component, ViewSelectionConfigDialog, ArMemToImageProvider, AzureKinectPointCloudProvider, HumanActivityDebugger, HumanRobotInteractionDebugger, PersonInstanceUpdater, PersonMemoryDebugger, Component, DeepFaceRecognition, DummyArMarkerLocalizer, FakePointCloudProvider, ImagePassThrough, ImageProcessor, ImageProvider, ImageRecorderWidgetController, Component, IntelRealSenseProvider, KinectV1PointCloudProvider, KinectV2PointCloudProvider, NerianVisionPointCloudProvider, NuitrackPointCloudProvider, ObjectShapeClassification, OLPEvaluation, OpenNIPointCloudProvider, Component, PointCloudAndImageProcessor, PointCloudAndImageProvider, PointCloudProcessor, PointCloudProvider, RCPointCloudProvider, ResultImageAndPointCloudProvider, SimpleEpisodicMemoryOpenPoseEstimationConnector, SimpleEpisodicMemorySemanticGraphConnector, StereoImagePointCloudProvider, UCLObjectRecognition, UserAssistedSegmenterConfigDialog, and UserAssistedSegmenterGuiWidgetController.

◆ postOnConnectComponent()

virtual void postOnConnectComponent ( )
inlineprotectedvirtual

Reimplemented in Base.

◆ postOnDisconnectComponent()

virtual void postOnDisconnectComponent ( )
inlineprotectedvirtual

Reimplemented in Base.

◆ postOnExitComponent()

virtual void postOnExitComponent ( )
inlineprotectedvirtual

◆ postOnInitComponent()

virtual void postOnInitComponent ( )
inlineprotectedvirtual

◆ preambleGetTopic()

void preambleGetTopic ( std::string const & name)

◆ preOnConnectComponent()

virtual void preOnConnectComponent ( )
inlineprotectedvirtual

Reimplemented in Component, and Base.

◆ preOnDisconnectComponent()

virtual void preOnDisconnectComponent ( )
inlineprotectedvirtual

◆ preOnExitComponent()

virtual void preOnExitComponent ( )
inlineprotectedvirtual

◆ preOnInitComponent()

virtual void preOnInitComponent ( )
inlineprotectedvirtual

Reimplemented in Component.

◆ removeProxyDependency()

bool removeProxyDependency ( const std::string & name)
protected

This function removes the dependency of this object on the in parameter name specified object.

Parameters
namename of the depedency proxy
Returns
returns true if depedency was found and removed false if dependency does not exist

◆ setMetaInfo()

void setMetaInfo ( const std::string & id,
const VariantBasePtr & value )

Allows to set meta information that can be queried live via Ice interface on the ArmarXManager.

Parameters
idId and description of the meta information.
valueValue to be stored. Should only be basic types and strings.

◆ setName()

void setName ( std::string name)
protected

Override name of well-known object.

◆ startPeriodicTask()

void startPeriodicTask ( const std::string & uniqueName,
std::function< void(void)> f,
int periodMs,
bool assureMeanInterval = false,
bool forceSystemTime = true )

◆ stopPeriodicTask()

bool stopPeriodicTask ( const std::string & name)

◆ terminate()

void terminate ( )
protected

Initiates termination of this IceManagedObject.

Returns immediately.

◆ unsubscribeFromTopic()

bool unsubscribeFromTopic ( const std::string & name)

Unsubscribe from a topic.

Parameters
nameName of the topic
Returns
True if the ManagedIceObject was subscribed before, false otherwise.

◆ usingProxy()

bool usingProxy ( const std::string & name,
const std::string & endpoints = "" )

Registers a proxy for retrieval after initialization and adds it to the dependency list.

This ManagedIceObject won't start (onConnectComponent()) until this proxy is avaiable.

Parameters
nameProxy name
endpointsSpecific endpoints, e.g. tcp ‑p 10002
Returns
returns true if new dependency, else false

◆ usingTopic()

void usingTopic ( const std::string & name,
bool orderedPublishing = false )

Registers a proxy for subscription after initialization.

Parameters
nameTopic name
See also
unsubscribeFromTopic()

◆ waitForObjectScheduler()

void waitForObjectScheduler ( )

Waits until the ObjectScheduler could resolve all dependencies.

◆ waitForProxy()

void waitForProxy ( std::string const & name,
bool addToDependencies )

Friends And Related Symbol Documentation

◆ ArmarXManager

friend class ArmarXManager
friend

◆ ArmarXObjectScheduler

friend class ArmarXObjectScheduler
friend

◆ Component

friend class Component
friend

◆ ManagedIceObjectPlugin

friend class ManagedIceObjectPlugin
friend

Member Data Documentation

◆ NullPtr

const ManagedIceObjectPtr NullPtr
static

A nullptr to be used when a const ref to a nullptr is required.


The documentation for this class was generated from the following files: