Field to encapsulate a pointer to an output connector which represents a module output. More...

#include <mlFields.h>

Inheritance diagram for ml::OutputConnectorField:

Public Member Functions
	OutputConnectorField ()
	Default constructor, do not use it.
	OutputConnectorField (const std::string &name, Module *module, MLint outputImageIndex)
	Constructor, creates a field with a `name` to manage an OutputConnector on the Module `module` at index `outputImageIndex`.
virtual	~OutputConnectorField ()
	Destroys the field.
void	setStringValue (const std::string &)
	Only calls touch() to propagate notifications.
virtual void	touch (FieldSensor::Strength strength=FieldSensor::CHANGED)
	A notified output image must also clear its PagedImage if it is considered as changed.
std::string	getStringValue () const
	Reference to OutputConnector as C-string to return (OutputConnector do not have a value, therefore reference is returned).
OutputConnector &	getOutputConnectorValue () const
	Returns a reference to the OutputConnector.
virtual MLint	isValidValue ()
	Returns 1 if connector field contains a valid connector pointer.

Detailed Description

Field to encapsulate a pointer to an output connector which represents a module output.

Definition at line 879 of file mlFields.h.

Constructor & Destructor Documentation

ml::OutputConnectorField::OutputConnectorField ( )

Default constructor, do not use it.

ml::OutputConnectorField::OutputConnectorField	(	const std::string &	name,
		Module *	module,
		MLint	outputImageIndex
	)

Constructor, creates a field with a name to manage an OutputConnector on the Module module at index outputImageIndex.

virtual ml::OutputConnectorField::~OutputConnectorField ( ) [virtual]

Destroys the field.

OutputConnector& ml::OutputConnectorField::getOutputConnectorValue ( ) const

Returns a reference to the OutputConnector.

std::string ml::OutputConnectorField::getStringValue ( ) const [virtual]

Reference to OutputConnector as C-string to return (OutputConnector do not have a value, therefore reference is returned).

Returns the value of the field as a string value. setStringValue must be able to interpret this returned string correctly.

Implements ml::Field.

virtual MLint ml::OutputConnectorField::isValidValue ( ) [virtual]

Returns 1 if connector field contains a valid connector pointer.

Reimplemented from ml::Field.

void ml::OutputConnectorField::setStringValue ( const std::string & ) [virtual]

Only calls touch() to propagate notifications.

It implicitly clears the cache of the output connector field.

Implements ml::Field.

virtual void ml::OutputConnectorField::touch ( FieldSensor::Strength strength = FieldSensor::CHANGED ) [virtual]

A notified output image must also clear its PagedImage if it is considered as changed.

So it needs to be overloaded here. Default is that it is considered as FieldSensor::CHANGED.

Reimplemented from ml::Field.

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