ManagedIceObjectDependency Class Referenceabstract

The ManagedIceObjectDependency class is part of the ManagedIceObjectConnectivity. More...

#include <ArmarXCore/core/ManagedIceObjectDependency.h>

+ Inheritance diagram for ManagedIceObjectDependency:

Public Member Functions

void check ()
 This method is called to check the dependency and update the resolved and statechanged members. More...
 
std::string getName (const Ice::Current &c=Ice::emptyCurrent) override
 Retrieve name of dependency. More...
 
bool getResolved (const Ice::Current &c=Ice::emptyCurrent) override
 Retrieve whether dependency is resolved. More...
 
bool getStateChanged ()
 Retrieve whether state has changed since the last call to the method. More...
 
std::string getType (const Ice::Current &c=Ice::emptyCurrent) override
 Retrieve type of dependency. More...
 
 ManagedIceObjectDependency ()
 Required by factory functions. More...
 
 ManagedIceObjectDependency (IceManagerPtr iceManager, std::string name, std::string type)
 Constructs a ManagedIceObjectDependency. More...
 

Protected Member Functions

virtual bool checkDependency ()=0
 

Protected Attributes

IceManagerPtr iceManager
 

Detailed Description

The ManagedIceObjectDependency class is part of the ManagedIceObjectConnectivity.

For each dependency on the distributed application, a ManagedIceObjectDependency is added. The dependencies are resolved by the ArmarXObjectScheduler.

The checkDependency method needs to be implemented in each dependency.

Definition at line 63 of file ManagedIceObjectDependency.h.

Constructor & Destructor Documentation

◆ ManagedIceObjectDependency() [1/2]

Required by factory functions.

Definition at line 70 of file ManagedIceObjectDependency.h.

◆ ManagedIceObjectDependency() [2/2]

ManagedIceObjectDependency ( IceManagerPtr  iceManager,
std::string  name,
std::string  type 
)
inline

Constructs a ManagedIceObjectDependency.

Parameters
iceManagerpointer to the ice manager
namename of dependant object
typetype of dependency

Definition at line 79 of file ManagedIceObjectDependency.h.

Member Function Documentation

◆ check()

void check ( )
inline

This method is called to check the dependency and update the resolved and statechanged members.

Internally calls checkDependency of subclass.

Definition at line 138 of file ManagedIceObjectDependency.h.

◆ checkDependency()

virtual bool checkDependency ( )
protectedpure virtual

Implemented in ProxyDependency.

◆ getName()

std::string getName ( const Ice::Current &  c = Ice::emptyCurrent)
inlineoverride

Retrieve name of dependency.

Part of the Ice interface.

Parameters
cIce context
Returns
name of dependant object

Definition at line 95 of file ManagedIceObjectDependency.h.

◆ getResolved()

bool getResolved ( const Ice::Current &  c = Ice::emptyCurrent)
inlineoverride

Retrieve whether dependency is resolved.

Part of the Ice interface.

Parameters
cIce context
Returns
dependency resolved

Definition at line 117 of file ManagedIceObjectDependency.h.

◆ getStateChanged()

bool getStateChanged ( )
inline

Retrieve whether state has changed since the last call to the method.

Returns
state change condition

Definition at line 127 of file ManagedIceObjectDependency.h.

◆ getType()

std::string getType ( const Ice::Current &  c = Ice::emptyCurrent)
inlineoverride

Retrieve type of dependency.

Part of the Ice interface.

Parameters
cIce context
Returns
type of the dependency

Definition at line 106 of file ManagedIceObjectDependency.h.

Member Data Documentation

◆ iceManager

IceManagerPtr iceManager
protected

Definition at line 154 of file ManagedIceObjectDependency.h.


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