Handles help and documentation generation but does not provide Ice functionality. More...
#include <ArmarXCore/core/ArmarXDummyManager.h>
Inheritance diagram for ArmarXDummyManager:Public Member Functions | |
| void | addObject (const ManagedIceObjectPtr &object, bool addWithOwnAdapter=true, const std::string &objectName="", bool useOwnScheduleThread=true) override |
| Add a ManagedIceObject to the dummy manager. More... | |
| std::vector< ManagedIceObjectPtr > | getManagedObjects () override |
| Retrieve pointers to all ManagedIceObject. More... | |
| void | removeObjectBlocking (const ManagedIceObjectPtr &object) override |
| Removes an object from the registry. More... | |
| void | removeObjectBlocking (const std::string &objectName) override |
| Removes an object from the manageregistry. More... | |
| void | removeObjectNonBlocking (const ManagedIceObjectPtr &object) override |
| Removes an object from the registry. More... | |
| void | removeObjectNonBlocking (const std::string &objectName) override |
| Removes an object from the registry. More... | |
Detailed Description
Handles help and documentation generation but does not provide Ice functionality.
The ArmarXDummyManager implements the ManagedIceObjectRegistryInterface and thus provides all ManagedIceObject adding and removal functionality. In contrast to the ArmarXManager, no Ice setup is performed and the objects are not started.
This manager is used in order to parse the options of all ManagedIceObject added to the ArmarXManager for the help and automatic documentation generation.
Definition at line 52 of file ArmarXDummyManager.h.
Member Function Documentation
◆ addObject()
|
inlineoverridevirtual |
Add a ManagedIceObject to the dummy manager.
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
-
object object to add
Implements ManagedIceObjectRegistryInterface.
Definition at line 65 of file ArmarXDummyManager.h.
◆ getManagedObjects()
|
inlineoverridevirtual |
Retrieve pointers to all ManagedIceObject.
- Returns
- vector of pointers
Implements ManagedIceObjectRegistryInterface.
Definition at line 128 of file ArmarXDummyManager.h.
◆ removeObjectBlocking() [1/2]
|
inlineoverridevirtual |
Removes an object from the registry.
This version waits until all calls to this component are finished and the has been completely removed.
- Parameters
-
object object to remove
Implements ManagedIceObjectRegistryInterface.
Definition at line 79 of file ArmarXDummyManager.h.
◆ removeObjectBlocking() [2/2]
|
inlineoverridevirtual |
Removes an object from the manageregistry.
This version waits until all calls to this component are finished and the has been completely removed.
- Parameters
-
objectName name of the object to remove
Implements ManagedIceObjectRegistryInterface.
Definition at line 92 of file ArmarXDummyManager.h.
◆ removeObjectNonBlocking() [1/2]
|
inlineoverridevirtual |
Removes an object from the registry.
This version returns immediatly and does not wait for all call to this to finish.
- Parameters
-
object object to remove
Implements ManagedIceObjectRegistryInterface.
Definition at line 105 of file ArmarXDummyManager.h.
◆ removeObjectNonBlocking() [2/2]
|
inlineoverridevirtual |
Removes an object from the registry.
This version returns immediatly and does not wait for all call to this to finish.
- Parameters
-
objectName name of the object to remove
Implements ManagedIceObjectRegistryInterface.
Definition at line 118 of file ArmarXDummyManager.h.
The documentation for this class was generated from the following file:
- ArmarXCore/core/ArmarXDummyManager.h
