ArmarXDummyManager Class Reference

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.
std::vector< ManagedIceObjectPtr >	getManagedObjects () override
	Retrieve pointers to all ManagedIceObject.
void	removeObjectBlocking (const ManagedIceObjectPtr &object) override
	Removes an object from the registry.
void	removeObjectBlocking (const std::string &objectName) override
	Removes an object from the manageregistry.
void	removeObjectNonBlocking (const ManagedIceObjectPtr &object) override
	Removes an object from the registry.
void	removeObjectNonBlocking (const std::string &objectName) override
	Removes an object from the registry.

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.

Member Function Documentation

addObject()

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

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.

getManagedObjects()

std::vector< ManagedIceObjectPtr > getManagedObjects ( )

inlineoverridevirtual

Retrieve pointers to all ManagedIceObject.

Returns

vector of pointers

Implements ManagedIceObjectRegistryInterface.

removeObjectBlocking() [1/2]

void removeObjectBlocking ( const ManagedIceObjectPtr & object )

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.

removeObjectBlocking() [2/2]

void removeObjectBlocking ( const std::string & objectName )

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.

removeObjectNonBlocking() [1/2]

void removeObjectNonBlocking ( const ManagedIceObjectPtr & object )

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.

removeObjectNonBlocking() [2/2]

void removeObjectNonBlocking ( const std::string & objectName )

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.

---

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

• ArmarXCore/core/ArmarXDummyManager.h