MeVisLabToolboxReference
ml::NotifyField Class Reference

Field without value for notifications. More...

#include <mlFields.h>

Inheritance diagram for ml::NotifyField:
ml::Field

Public Member Functions

 NotifyField ()
 Implements the runtime type system interface for this class. More...
 
 NotifyField (const std::string &name)
 Constructor, creates a notification field with a name. More...
 
void setStringValue (const std::string &) override
 Only calls notifyAttachments() to notify attached fields or sensors. More...
 
std::string getStringValue () const override
 Returns an empty string, because the field has no value. More...
 
void notify ()
 Calls touch() to notify connected sensors or fields. More...
 
- Public Member Functions inherited from ml::Field
 Field (const std::string &name=std::string())
 Constructor: Creates a field with name. More...
 
virtual ~Field ()
 Destructor: Destroy field and remove all connection to fields an sensors. More...
 
FieldContainergetFieldContainer () const
 Get the field container of the field (which may be NULL). More...
 
const std::string & getName () const
 Returns name of field. More...
 
void setName (const std::string &name)
 Sets the name of field. Should be called only once after or while construction. More...
 
bool isOutputOnly () const
 Returns if this field is marked as pure output field. More...
 
void setOutputOnly (bool outputOnly=true)
 Mark field as a pure output field that is never read by its module. More...
 
virtual MLint isValidValue ()
 Returns true (=1) if the field's value is valid; otherwise false (=0) is returned. More...
 
void copyCStringValue (char *valueBuffer, MLint bufferSize)
 Copies the value of the field (as character string) into the specified buffer valueBuffer. More...
 
MLint getCStringValueSize ()
 Returns the length of the character string of the string value of the field. More...
 
void attachFieldSensor (FieldSensor *sensor)
 Attaches a field sensor sensor of this class instance in both directions. More...
 
void detachFieldSensor (FieldSensor *sensor)
 Detaches the field sensor sensor of this class instance in both directions. More...
 
void detachFieldSensors ()
 Detaches all field sensors of this class instance in both directions. More...
 
void attachField (OutputConnectorField *targetField)
 This calls attachField(targetField, false). More...
 
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. More...
 
void detachField (Field *targetField)
 Disconnects connections between target field targetField and this instance. More...
 
void detachSourceFields ()
 Disconnects all source fields of this instance in both directions. More...
 
void detachDestinationFields ()
 Disconnects all target fields of this instance in both directions. More...
 
void detachAllFields ()
 Disconnects all source and target fields of this instance in both directions. More...
 
size_t getNumDestinationFields ()
 Returns the number of destination fields which could receive notifications or value sets. More...
 
FieldgetDestinationField (size_t index)
 Returns destination field at index. Returns NULL if index is out of range. More...
 
size_t getNumSourceFields ()
 Returns the number of source fields which could send notifications or value sets. More...
 
FieldgetSourceField (size_t index)
 Returns the source field at index. Returns NULL if index is out of range. More...
 
virtual void touch (FieldSensor::Strength strength=FieldSensor::CHANGED)
 Notifies all connected fields and field sensors. More...
 
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. More...
 
bool areNotificationsEnabled ()
 Returns whether the notification mechanism for this field (e.g., when field values are set) is enabled (see enableNotifications(bool) ). More...
 
void deactivateAttachments ()
 
void activateAttachments ()
 
MLint isActiveAttachments ()
 

Additional Inherited Members

- 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. More...
 
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. More...
 
static MLintenableNotificationsCounterState ()
 Provides read/write access to the current counter state (see enableNotificationsGlobally(bool) ). More...
 
static void disableNotifications ()
 
static void enableNotifications ()
 
static MLint isEnabledNotifications ()
 
- 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. More...
 
void detachSourceField (Field *field)
 Removes a source field from this instance. If not found then this call does nothing. More...
 
void detachFieldInternal (Field *field)
 Only remove the given field from the destination list. More...
 
virtual void setValueFromField (const Field &field)
 Sets the value of this field from the given field. More...
 
- Protected Attributes inherited from ml::Field
std::string _name
 The name of this field. More...
 
std::vector< FieldSensor * > _sensors
 List of field sensors. More...
 
std::vector< Field * > _destinationFields
 List of (target) fields which shall be set to the value of this field or which shall be notified only if this field is changed or notified. More...
 
std::vector< Field * > _sourceFields
 List of (source) fields, which will notify this field or which will copy their value to this field. More...
 
FieldContainer_fieldContainer
 The owning field container. More...
 
Flags _flags
 
- Static Protected Attributes inherited from ml::Field
static MLint _enableNotifications
 Flag which disables the notification process of field (sensors) globally. More...
 

Detailed Description

Field without value for notifications.

Definition at line 1040 of file mlFields.h.

Constructor & Destructor Documentation

◆ NotifyField() [1/2]

ml::NotifyField::NotifyField ( )

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ NotifyField() [2/2]

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

Constructor, creates a notification field with a name.

The field does not contain a value and is designed only to handle notifications.

Member Function Documentation

◆ getStringValue()

std::string ml::NotifyField::getStringValue ( ) const
overridevirtual

Returns an empty string, because the field has no value.

Implements ml::Field.

◆ notify()

void ml::NotifyField::notify ( )

Calls touch() to notify connected sensors or fields.

◆ setStringValue()

void ml::NotifyField::setStringValue ( const std::string &  )
overridevirtual

Only calls notifyAttachments() to notify attached fields or sensors.

Passed string values are ignored.

Implements ml::Field.


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