ml::InputConnectorField Class Reference
Field to encapsulate a pointer to an input connector which represents a module input. More...
#include <mlFields.h>
Inheritance diagram for ml::InputConnectorField:
Public Member Functions | |
| InputConnectorField () | |
| Default constructor, do not use it. | |
| InputConnectorField (const std::string &name, Module *module, MLint inputImageIndex) | |
Constructor, creates a field with a name to manage an InputConnector on the Module module at index inputImageIndex. | |
| virtual | ~InputConnectorField () |
| Destroys the field. | |
| void | setStringValue (const std::string &) |
| Only calls touch() to propagate notifications. | |
| std::string | getStringValue () const |
| Returns a reference to InputConnector as a C-string (InputConnector does not have a value). | |
| InputConnector & | getInputConnectorValue () const |
| Returns a reference to the InputConnector. | |
| virtual MLint | isValidValue () |
| Returns 1 if connector field contains a valid connector pointer. | |
Detailed Description
Field to encapsulate a pointer to an input connector which represents a module input.
Definition at line 934 of file mlFields.h.
Constructor & Destructor Documentation
| ml::InputConnectorField::InputConnectorField | ( | ) |
Default constructor, do not use it.
| ml::InputConnectorField::InputConnectorField | ( | const std::string & | name, |
| Module * | module, | ||
| MLint | inputImageIndex | ||
| ) |
Constructor, creates a field with a name to manage an InputConnector on the Module module at index inputImageIndex.
Note that the field always stores a pointer to the connector as field value.
| virtual ml::InputConnectorField::~InputConnectorField | ( | ) | [virtual] |
Destroys the field.
Member Function Documentation
| InputConnector& ml::InputConnectorField::getInputConnectorValue | ( | ) | const |
Returns a reference to the InputConnector.
| std::string ml::InputConnectorField::getStringValue | ( | ) | const [virtual] |
Returns a reference to InputConnector as a C-string (InputConnector does not have a value).
Implements ml::Field.
| virtual MLint ml::InputConnectorField::isValidValue | ( | ) | [virtual] |
Returns 1 if connector field contains a valid connector pointer.
Reimplemented from ml::Field.
| void ml::InputConnectorField::setStringValue | ( | const std::string & | ) | [virtual] |
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlFields.h
