MeVisLab Toolbox Reference
|
Class to manage an input connection of a Module module. More...
#include <mlConnectors.h>
Public Member Functions | |
InputConnector (Module &module, MLint index) | |
Constructor: Creates an input connection for module module at input index . | |
InputConnector (Module &module, MLint index, OutputConnector &outputConnector) | |
Constructor: Creates an input connection for the module module at input index and connect bidirectionally with output connector outputConnector . | |
virtual | ~InputConnector () |
Destructor: Destroys this and its connection to the OutputConnector bidirectionally. | |
Module & | getModule () const |
Returns the Module to which this connector belongs to. | |
MLint | getIndex () const |
Returns the index of the input connection that is represented by this connector. | |
OutputConnector * | getConnector () const |
Returns the connected OutputConnector. Could be NULL. | |
void | connect (OutputConnector &connector) |
Creates a connection between this and the OutputConnector connector bidirectionally. | |
void | disconnect () |
Disconnects this connector from the OutputConnector bidirectionally if it exists. | |
bool | isValidConnection () const |
Returns true if bidirectional connection is valid; otherwise, it returns false . | |
Friends | |
class | OutputConnector |
Class to manage an input connection of a Module module.
One or more instances of this class are assigned to the Module module thisOp. An instance of this represents the index'th image input of thisOp and it represents the connections with an OutputConnector of another (input) module.
Definition at line 124 of file mlConnectors.h.
Constructor: Creates an input connection for module module
at input index
.
ml::InputConnector::InputConnector | ( | Module & | module, |
MLint | index, | ||
OutputConnector & | outputConnector ) |
Constructor: Creates an input connection for the module module
at input index
and connect bidirectionally with output connector outputConnector
.
|
virtual |
Destructor: Destroys this and its connection to the OutputConnector bidirectionally.
void ml::InputConnector::connect | ( | OutputConnector & | connector | ) |
Creates a connection between this and the OutputConnector connector
bidirectionally.
connector
must be non-NULL.
void ml::InputConnector::disconnect | ( | ) |
Disconnects this connector from the OutputConnector bidirectionally if it exists.
OutputConnector * ml::InputConnector::getConnector | ( | ) | const |
Returns the connected OutputConnector. Could be NULL.
MLint ml::InputConnector::getIndex | ( | ) | const |
Returns the index of the input connection that is represented by this connector.
Module & ml::InputConnector::getModule | ( | ) | const |
Returns the Module to which this connector belongs to.
bool ml::InputConnector::isValidConnection | ( | ) | const |
Returns true
if bidirectional connection is valid; otherwise, it returns false
.
This is for debug purposes only; the API does not allow such invalid connections.
|
friend |
Definition at line 162 of file mlConnectors.h.