ml::ObjMgrBase Class Reference
Base class for all communicating modules. More...
#include <ObjMgr/mlObjMgrBase.h>
Inheritance diagram for ml::ObjMgrBase:
Public Member Functions | |
| ~ObjMgrBase () | |
| Macro for declaring methods for the runtime system. | |
Public Attributes | |
| BaseField * | objectsOutFld |
| Access field to object container. | |
Protected Member Functions | |
| ObjMgrBase (int inputNum, int outputNum) | |
| Constructor. | |
| void | notifySensorsAndConnectedClients (bool fireOutputSensors) |
| Notify all directly connected modules. | |
| void | configureNetwork () |
| (Re)initialize/configure client connections. | |
| virtual std::string | getDebugComment () const =0 |
| Return debug comment. | |
| void | buildGraph (std::multimap< ObjMgrBase *, ObjMgrBase * > &graph) |
| May be used to build a graph of the network originating from this module. | |
Protected Attributes | |
| omObjMgrConnection | _connection |
| Current connection that originates from this module. | |
| std::set< ObjMgrBase * > | _connectedModules |
| Container of directly connected ObjMgrBase modules. | |
Friends | |
| class | ObjMgrClient |
Detailed Description
Base class for all communicating modules.
Definition at line 38 of file mlObjMgrBase.h.
Constructor & Destructor Documentation
| ml::ObjMgrBase::~ObjMgrBase | ( | ) |
Macro for declaring methods for the runtime system.
Destructor
| ml::ObjMgrBase::ObjMgrBase | ( | int | inputNum, | |
| int | outputNum | |||
| ) | [protected] |
Constructor.
Member Function Documentation
| void ml::ObjMgrBase::buildGraph | ( | std::multimap< ObjMgrBase *, ObjMgrBase * > & | graph | ) | [protected] |
May be used to build a graph of the network originating from this module.
The multimap consists of parents (nodes with the same key) and their directly connected client modules.
| void ml::ObjMgrBase::configureNetwork | ( | ) | [protected] |
(Re)initialize/configure client connections.
| virtual std::string ml::ObjMgrBase::getDebugComment | ( | ) | const [protected, pure virtual] |
| void ml::ObjMgrBase::notifySensorsAndConnectedClients | ( | bool | fireOutputSensors | ) | [protected] |
Notify all directly connected modules.
Friends And Related Function Documentation
friend class ObjMgrClient [friend] |
Member Data Documentation
std::set<ObjMgrBase *> ml::ObjMgrBase::_connectedModules [protected] |
omObjMgrConnection ml::ObjMgrBase::_connection [protected] |
Access field to object container.
A notification to this field is given after this module has handled the notification itself.
Definition at line 54 of file mlObjMgrBase.h.
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLObjMgr/ObjMgr/mlObjMgrBase.h
