Field to encapsulate a double value. More...

#include <mlFields.h>

Inheritance diagram for ml::DoubleField:

Public Member Functions
	DoubleField ()=default
	Implements the runtime type system interface for this class.

	DoubleField (const std::string &name)
	Constructor; creates a field with a `name` to manage a double value.

void	setStringValue (const std::string &stringValue) override
	Sets the value of the field to `stringValue`.

void	setDoubleValue (double doubleValue)
	Sets the field value to `doubleValue`. By default, the entire double type range can be set.

void	updateDoubleValue (double doubleValue)
	Sets the field value to `doubleValue`, but only touches the field if the new value is different from the old value.

std::string	getStringValue () const override
	Returns the value of the field as a string value setStringValue must be able to reinterpret this returned string correctly.

double	getDoubleValue () const
	Returns the current field value.

void	setValue (double doubleValue)
	Same as setDoubleValue().

void	updateValue (double doubleValue)
	Same as updateDoubleValue().

double	getValue () const
	Same as getDoubleValue().

Public Member Functions inherited from ml::Field
	Field (const std::string &name=std::string())
	Constructor: Creates a field with `name`.

virtual	~Field ()
	Destructor: Destroys a field and removes all connection to fields and sensors.

FieldContainer *	getFieldContainer () const
	Returns the field container of the field (which may be NULL).

const std::string &	getName () const
	Returns the name of field.

void	setName (const std::string &name)
	Sets the `name` of field. Should be called only once after or while construction.

std::string	getFullName () const
	Returns 'fieldContainerType(instanceName).fieldName' if field container is available, otherwise only the field name is returned.

bool	isOutputOnly () const
	Returns whether this field is marked as a pure output field.

void	setOutputOnly (bool outputOnly=true)
	Marks this field as a pure output field that is only changed by its module.

virtual MLint	isValidValue ()
	Returns true (=1) if the field's value is valid; otherwise, false (=0) is returned.

void	copyCStringValue (char *valueBuffer, MLint bufferSize)
	Copies the value of the field (as character string) into the specified buffer `valueBuffer`.

MLint	getCStringValueSize ()
	Returns the length of the character string of the string value of the field.

void	attachFieldSensor (FieldSensor *sensor)
	Attaches a field sensor `sensor` of this class instance in both directions.

void	detachFieldSensor (FieldSensor *sensor)
	Detaches the field sensor `sensor` of this class instance in both directions.

void	detachFieldSensors ()
	Detaches all field sensors of this class instance in both directions.

void	attachField (OutputConnectorField *targetField)
	This calls attachField(targetField, false).

void	attachField (BaseField *targetField)

void	attachField (SoNodeField *targetField)

void	attachField (NotifyField *targetField)

void	attachField (Field *targetField, bool propagateValueOnConnect)
	Connects this class instance with the target field `targetField`.

void	detachField (Field *targetField)
	Disconnects connections between the target field `targetField` and this instance.

void	detachSourceFields ()
	Disconnects all source fields of this instance in both directions.

void	detachDestinationFields ()
	Disconnects all target fields of this instance in both directions.

void	detachAllFields ()
	Disconnects all source and target fields of this instance in both directions.

size_t	getNumDestinationFields ()
	Returns the number of destination fields that could receive notifications or value sets.

Field *	getDestinationField (size_t index)
	Returns the destination field at `index`. Returns NULL if `index` is out of range.

size_t	getNumSourceFields ()
	Returns the number of source fields that could send notifications or value sets.

Field *	getSourceField (size_t index)
	Returns the source field at `index`. Returns NULL if `index` is out of range.

virtual void	touch (FieldSensor::Strength strength=FieldSensor::CHANGED)
	Notifies all connected fields and field sensors.

void	enableNotifications (bool flag)
	Enables or disables notification of attached fields and field sensors when the field value is set or notified (by notifyAttachments() or set*Value() -methods), depending on the parameter `flag`.

bool	areNotificationsEnabled ()
	Returns whether the notification mechanism for this field (e.g., when field values are set) is enabled (see enableNotifications(bool) ).

Static Public Member Functions
static void	setValueCallback (void *field, double value)
	Callback method that can be used as a MLRequestProgressCB to set the progress to the field.

Static Public Member Functions inherited from ml::Field
static void	enableNotificationsGlobally (bool flag)
	Enables or disables globally the notification mechanism for all fields and field sensors when field values are set or notified (by notifyAttachments() or set*Value() methods), depending on the parameter `flag`.

static bool	areNotificationsEnabledGlobally ()
	Returns whether the notification mechanism for all fields (e.g., when field values are set) is enabled (see enableNotificationsGlobally(bool) ) Usually it is false (=0) within all calls of Module::calc* methods to avoid that field changes within these methods recursively start the calculation process of the ML.

static MLint &	enableNotificationsCounterState ()
	Provides read/write access to the current counter state (see enableNotificationsGlobally(bool) ).

Protected Member Functions
void	setValueFromField (const Field &field) override
	Reimplementation from Field, which copies the field value more efficiently.

Protected Member Functions inherited from ml::Field
void	attachSourceField (Field *field)
	Inserts a field as source `field` in this instance, i.e., from now on *this might receive values and/or notifications from that field.

void	detachSourceField (Field *field)
	Removes a source `field` from this instance. If not found, then this call does nothing.

void	detachFieldInternal (Field *field)
	Only removes the given field from the destination list.

Additional Inherited Members
Protected Attributes inherited from ml::Field
std::string	_name
	The name of this field.

std::vector< FieldSensor * >	_sensors
	List of field sensors.

std::vector< Field * >	_destinationFields
	List of (target) fields that shall be set to the value of this field or that shall be notified only if this field is changed or notified.

std::vector< Field * >	_sourceFields
	List of (source) fields that will notify this field or that will copy their value to this field.

FieldContainer *	_fieldContainer
	The owning field container.

Flags	_flags

Static Protected Attributes inherited from ml::Field
static MLint	_enableNotifications
	Flag that disables the notification process of field (-sensors) globally.

Detailed Description

Field to encapsulate a double value.

Definition at line 493 of file mlFields.h.

Constructor & Destructor Documentation

◆ DoubleField() [1/2]

ml::DoubleField::DoubleField ( )

default

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ DoubleField() [2/2]

ml::DoubleField::DoubleField ( const std::string & name )

explicit

Constructor; creates a field with a name to manage a double value.

Default value is 0.

Member Function Documentation

◆ getDoubleValue()

double ml::DoubleField::getDoubleValue ( ) const

Returns the current field value.

◆ getStringValue()

std::string ml::DoubleField::getStringValue ( ) const

overridevirtual

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

Implements ml::Field.

◆ getValue()

double ml::DoubleField::getValue ( ) const

inline

Same as getDoubleValue().

Definition at line 534 of file mlFields.h.

◆ setDoubleValue()

void ml::DoubleField::setDoubleValue ( double doubleValue )

Sets the field value to doubleValue. By default, the entire double type range can be set.

◆ setStringValue()

void ml::DoubleField::setStringValue ( const std::string & stringValue )

overridevirtual

Sets the value of the field to stringValue.

Implements ml::Field.

◆ setValue()

void ml::DoubleField::setValue ( double doubleValue )

inline

Same as setDoubleValue().

Definition at line 528 of file mlFields.h.

◆ setValueCallback()

static void ml::DoubleField::setValueCallback	(	void *	field,
		double	value
	)

static

Callback method that can be used as a MLRequestProgressCB to set the progress to the field.

◆ setValueFromField()

void ml::DoubleField::setValueFromField ( const Field & field )

overrideprotectedvirtual

Reimplementation from Field, which copies the field value more efficiently.

Reimplemented from ml::Field.

◆ updateDoubleValue()

void ml::DoubleField::updateDoubleValue ( double doubleValue )

Sets the field value to doubleValue, but only touches the field if the new value is different from the old value.

Note that values must be identical to avoid touching the field! By default, the entire double type range can be set.

◆ updateValue()

void ml::DoubleField::updateValue ( double doubleValue )

inline

Same as updateDoubleValue().

Definition at line 531 of file mlFields.h.

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

MeVis/Foundation/Sources/ML/include/mlFields.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DoubleField() [1/2]

◆ DoubleField() [2/2]

Member Function Documentation

◆ getDoubleValue()

◆ getStringValue()

◆ getValue()

◆ setDoubleValue()

◆ setStringValue()

◆ setValue()

◆ setValueCallback()

◆ setValueFromField()

◆ updateDoubleValue()

◆ updateValue()