Field to encapsulate an increasing float value from range [0,1]. More...

#include <mlFields.h>

Inheritance diagram for ml::ProgressField:

Public Member Functions
	ProgressField ()
	Implements the runtime type system interface for this class.

	ProgressField (const std::string &name)
	Constructor, creates a field with a `name` to manage a progressive float value.

void	setFloatValue (float floatValue)
	Sets field value to `floatValue` if floatValue==0, floatValue==1, or floatValue > previous floatValue + setUpdateDifference.

void	setProgressValue (float floatValue)
	Same as setFloatValue().

float	getProgressValue ()
	Same as getFloatValue().

void	setUpdateDifference (float epsilonValue)
	Sets an epsilon value such that a new value must be greater than the previous value to be accepted as a new field value.

void	setValue (float floatValue)
	Same as setFloatValue().

Public Member Functions inherited from ml::FloatField
	FloatField ()=default
	Implements the runtime type system interface for this class.

	FloatField (const std::string &name)
	Constructor; creates a field with a `name` to manage a float value with 0 as a default value.

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

void	setFloatValue (float floatValue)
	Sets the field value to `floatValue`.

void	updateFloatValue (float floatValue)
	Sets the field value to `floatValue`, 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.

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
	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) ).

Additional Inherited Members
Static Public Member Functions inherited from ml::FloatField
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 inherited from ml::FloatField
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)
	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.

Protected Attributes inherited from ml::FloatField
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
	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 an increasing float value from range [0,1].

It accepts a new value only if it is 0, 1, or at least an epsilon higher than the previous value.

Definition at line 450 of file mlFields.h.

Constructor & Destructor Documentation

◆ ProgressField() [1/2]

ml::ProgressField::ProgressField ( )

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ ProgressField() [2/2]

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

explicit

Constructor, creates a field with a name to manage a progressive float value.

Default epsilon value is 0.02. Default value is 0.

Member Function Documentation

◆ getProgressValue()

float ml::ProgressField::getProgressValue ( )

inline

Same as getFloatValue().

Definition at line 474 of file mlFields.h.

◆ setFloatValue()

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

Sets field value to floatValue if floatValue==0, floatValue==1, or floatValue > previous floatValue + setUpdateDifference.

◆ setProgressValue()

void ml::ProgressField::setProgressValue ( float floatValue )

Same as setFloatValue().

◆ setUpdateDifference()

void ml::ProgressField::setUpdateDifference ( float epsilonValue )

Sets an epsilon value such that a new value must be greater than the previous value to be accepted as a new field value.

◆ setValue()

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