#include <mlFields.h>

Inheritance diagram for ml::BoolField:

Public Member Functions
	BoolField ()=default
	Implements the runtime type system interface for this class.
	BoolField (const std::string &name)
void	setStringValue (const std::string &value) override
	Sets the value of the field to `value`.
void	setBoolValue (bool boolValue)
	Sets the field value to `boolValue`.
void	updateBoolValue (bool boolValue)
void	toggleValue ()
	Toggles the boolean field value.
std::string	getStringValue () const override
	Returns the value of the field as string value.
bool	getBoolValue () const
	Returns the value of the field as a boolean.
bool	isOn () const
	Returns the value of the field as a boolean.
void	setValue (bool boolValue)
	Same as setBoolValue().
void	updateValue (bool boolValue)
	Same as updateBoolValue().
bool	getValue () const
	Same as getBoolValue().
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 ()

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.

Additional Inherited Members
static void	enableNotificationsGlobally (bool flag)
static bool	areNotificationsEnabledGlobally ()
static MLint &	enableNotificationsCounterState ()
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
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 boolean value.

Definition at line 55 of file mlFields.h.

Constructor & Destructor Documentation

◆ BoolField() [1/2]

ml::BoolField::BoolField ( )

default

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ BoolField() [2/2]

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

explicit

Constructor, creates a field with a name to manage a boolean value. Default value is false.

Member Function Documentation

◆ getBoolValue()

bool ml::BoolField::getBoolValue ( ) const

Returns the value of the field as a boolean.

Referenced by getValue().

◆ getStringValue()

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

overridevirtual

Returns the value of the field as string value.

Implements ml::Field.

◆ getValue()

bool ml::BoolField::getValue ( ) const

inline

Same as getBoolValue().

Definition at line 98 of file mlFields.h.

References getBoolValue().

◆ isOn()

bool ml::BoolField::isOn ( ) const

Returns the value of the field as a boolean.

◆ setBoolValue()

void ml::BoolField::setBoolValue ( bool boolValue )

Sets the field value to boolValue.

Referenced by setValue().

◆ setStringValue()

void ml::BoolField::setStringValue ( const std::string & value )

overridevirtual

Sets the value of the field to value.

Implements ml::Field.

◆ setValue()

void ml::BoolField::setValue ( bool boolValue )

inline

Same as setBoolValue().

Definition at line 92 of file mlFields.h.

References setBoolValue().

◆ setValueFromField()

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

overrideprotectedvirtual

Reimplementation from Field that copies the field value more efficiently.

Reimplemented from ml::Field.

References ml::Field::Field().

◆ toggleValue()

void ml::BoolField::toggleValue ( )

Toggles the boolean field value.

◆ updateBoolValue()

void ml::BoolField::updateBoolValue ( bool boolValue )

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

Referenced by updateValue().

◆ updateValue()

void ml::BoolField::updateValue ( bool boolValue )

inline

Same as updateBoolValue().

Definition at line 95 of file mlFields.h.

References updateBoolValue().

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BoolField() [1/2]

◆ BoolField() [2/2]

Member Function Documentation

◆ getBoolValue()

◆ getStringValue()

◆ getValue()

◆ isOn()

◆ setBoolValue()

◆ setStringValue()

◆ setValue()

◆ setValueFromField()

◆ toggleValue()

◆ updateBoolValue()

◆ updateValue()