#include <mlFields.h>

Inheritance diagram for ml::FloatField:

Public Member Functions
	FloatField ()=default
	Implements the runtime type system interface for this class.
	FloatField (const std::string &name)
void	setStringValue (const std::string &stringValue) override
	Sets the value of the field to `stringValue`.
void	setFloatValue (float floatValue)
void	updateFloatValue (float floatValue)
std::string	getStringValue () const override
float	getFloatValue () const
	Returns the value of the field.
void	setValue (float floatValue)
	Same as setFloatValue().
void	updateValue (float floatValue)
	Same as updateFloatValue().
float	getValue () const
	Same as getFloatValue().
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
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 ()
void	copyCStringValue (char *valueBuffer, MLint bufferSize)
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)
void	attachField (BaseField *targetField)
void	attachField (SoNodeField *targetField)
void	attachField (NotifyField *targetField)
void	attachField (Field *targetField, bool propagateValueOnConnect)
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)
void	enableNotifications (bool flag)
bool	areNotificationsEnabled ()

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 void	enableNotificationsGlobally (bool flag)
static bool	areNotificationsEnabledGlobally ()
static MLint &	enableNotificationsCounterState ()

Protected Member Functions
void	setValueFromField (const Field &field) override
	Reimplementation from Field that copies the field value more efficiently.
Protected Member Functions inherited from ml::Field
void	attachSourceField (Field *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.

Protected Attributes
float	_value {}
	The field value.
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
std::vector< Field * >	_sourceFields
FieldContainer *	_fieldContainer
	The owning field container.
Flags	_flags

Additional Inherited Members
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 float value.

Definition at line 388 of file mlFields.h.

Constructor & Destructor Documentation

◆ FloatField() [1/2]

ml::FloatField::FloatField ( )

default

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ FloatField() [2/2]

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

explicit

Constructor; creates a field with a name to manage a float value with 0 as a default value.

Member Function Documentation

◆ getFloatValue()

float ml::FloatField::getFloatValue ( ) const

Returns the value of the field.

Referenced by ml::ProgressField::getProgressValue(), and getValue().

◆ getStringValue()

std::string ml::FloatField::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()

float ml::FloatField::getValue ( ) const

inline

Same as getFloatValue().

Definition at line 429 of file mlFields.h.

References getFloatValue().

◆ setFloatValue()

void ml::FloatField::setFloatValue ( float floatValue )

Sets the field value to floatValue. By default, the entire float type range can be set.

Referenced by setValue().

◆ setStringValue()

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

overridevirtual

Sets the value of the field to stringValue.

Implements ml::Field.

◆ setValue()

void ml::FloatField::setValue ( float floatValue )

inline

Same as setFloatValue().

Definition at line 423 of file mlFields.h.

References setFloatValue().

◆ setValueCallback()

void ml::FloatField::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::FloatField::setValueFromField ( const Field & field )

overrideprotectedvirtual

Reimplementation from Field that copies the field value more efficiently.

Reimplemented from ml::Field.

References ml::Field::Field().

◆ updateFloatValue()

void ml::FloatField::updateFloatValue ( float floatValue )

Sets the field value to floatValue, 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 float type range can be set.

Referenced by updateValue().

◆ updateValue()

void ml::FloatField::updateValue ( float floatValue )

inline

Same as updateFloatValue().

Definition at line 426 of file mlFields.h.

References updateFloatValue().

Member Data Documentation

◆ _value

float ml::FloatField::_value {}

protected

The field value.

Definition at line 439 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

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FloatField() [1/2]

◆ FloatField() [2/2]

Member Function Documentation

◆ getFloatValue()

◆ getStringValue()

◆ getValue()

◆ setFloatValue()

◆ setStringValue()

◆ setValue()

◆ setValueCallback()

◆ setValueFromField()

◆ updateFloatValue()

◆ updateValue()

Member Data Documentation

◆ _value