ManagedIceObjectRegistryInterface Class Referenceabstract

The registery interface is implemented by ArmarXManagers. More...

#include <ArmarXCore/core/ManagedIceObjectRegistryInterface.h>

+ Inheritance diagram for ManagedIceObjectRegistryInterface:

Public Member Functions

virtual void addObject (const ManagedIceObjectPtr &object, bool addWithOwnAdapter=true, const std::string &objectName="", bool useOwnScheduleThread=true)=0
 Add a ManagedIceObject to the registry. More...
 
virtual std::vector< ManagedIceObjectPtrgetManagedObjects ()=0
 Retrieve pointers to all ManagedIceObject. More...
 
virtual void removeObjectBlocking (const ManagedIceObjectPtr &object)=0
 Removes an object from the registry. More...
 
virtual void removeObjectBlocking (const std::string &objectName)=0
 Removes an object from the manageregistry. More...
 
virtual void removeObjectNonBlocking (const ManagedIceObjectPtr &object)=0
 Removes an object from the registry. More...
 
virtual void removeObjectNonBlocking (const std::string &objectName)=0
 Removes an object from the registry. More...
 

Detailed Description

The registery interface is implemented by ArmarXManagers.

It is mainly used to provide the ArmarXDummyManager for properties parsing.

Definition at line 48 of file ManagedIceObjectRegistryInterface.h.

Member Function Documentation

◆ addObject()

virtual void addObject ( const ManagedIceObjectPtr object,
bool  addWithOwnAdapter = true,
const std::string &  objectName = "",
bool  useOwnScheduleThread = true 
)
pure virtual

Add a ManagedIceObject to the registry.

Takes care of the ManagedIceObject lifcycle using and ArmarXObjectScheduler. addObject is thread-safe and can be called from any method in order to dynamically add ManagedIceObjects (as e.g. required for GUI).

Parameters
objectobject to add
addWithOwnAdapterIf true this object will have it's own adapter
objectNameName that the object should have. if not empty overrides the currently set name.

Implemented in ArmarXManager, and ArmarXDummyManager.

◆ getManagedObjects()

virtual std::vector<ManagedIceObjectPtr> getManagedObjects ( )
pure virtual

Retrieve pointers to all ManagedIceObject.

Returns
vector of pointers

Implemented in ArmarXManager, and ArmarXDummyManager.

◆ removeObjectBlocking() [1/2]

virtual void removeObjectBlocking ( const ManagedIceObjectPtr object)
pure virtual

Removes an object from the registry.

This version waits until all calls to this component are finished and the has been completely removed.

Parameters
objectobject to remove

Implemented in ArmarXManager, and ArmarXDummyManager.

◆ removeObjectBlocking() [2/2]

virtual void removeObjectBlocking ( const std::string &  objectName)
pure virtual

Removes an object from the manageregistry.

This version waits until all calls to this component are finished and the has been completely removed.

Parameters
objectNamename of the object to remove

Implemented in ArmarXManager, and ArmarXDummyManager.

◆ removeObjectNonBlocking() [1/2]

virtual void removeObjectNonBlocking ( const ManagedIceObjectPtr object)
pure virtual

Removes an object from the registry.

This version returns immediatly and does not wait for all call to this to finish.

Parameters
objectobject to remove

Implemented in ArmarXManager, and ArmarXDummyManager.

◆ removeObjectNonBlocking() [2/2]

virtual void removeObjectNonBlocking ( const std::string &  objectName)
pure virtual

Removes an object from the registry.

This version returns immediatly and does not wait for all call to this to finish.

Parameters
objectNamename of the object to remove

Implemented in ArmarXManager, and ArmarXDummyManager.


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