MeVisLab Toolbox Reference
|
#include <mlListField.h>
Public Member Functions | |
ListField ()=default | |
Default constructor, do not use it. More... | |
ListField (const std::string &name) | |
Constructor; creates a list field with a name . More... | |
size_t | size () const |
Returns the number of elements of this fields value. More... | |
void | clear () |
Clears the value of this field. More... | |
void | setValues (const std::vector< T > &values) |
Sets the field value to values . More... | |
void | updateValues (const std::vector< T > &values) |
Sets the field value to values , but only touches the field if the new values are different from the old values. More... | |
std::vector< T > | getValues () const |
Returns the value of the field as a boolean. More... | |
void | setValueAt (size_t index, T value) |
Sets the field value at index index to value . More... | |
void | updateValueAt (size_t index, T value) |
Sets the field value at index index to value , but only touches the field if the new value is different from the old value at that index. More... | |
T | getValueAt (size_t index) const |
Returns component value at index index . index must be in range. More... | |
std::string | getStringValue () const override |
Returns the value of the field as string value. More... | |
void | setStringValue (const std::string &value) override |
Sets the value of the field to value . 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: Destroys a field and removes all connection to fields and sensors. More... | |
FieldContainer * | getFieldContainer () const |
Returns the field container of the field (which may be NULL). More... | |
const std::string & | getName () const |
Returns the 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... | |
std::string | getFullName () const |
Returns 'fieldContainerType(instanceName).fieldName' if field container is available, otherwise only the field name is returned. More... | |
bool | isOutputOnly () const |
Returns whether this field is marked as a pure output field. More... | |
void | setOutputOnly (bool outputOnly=true) |
Marks this field as a pure output field that is only changed 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 the 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 that could receive notifications or value sets. More... | |
Field * | getDestinationField (size_t index) |
Returns the destination field at index . Returns NULL if index is out of range. More... | |
size_t | getNumSourceFields () |
Returns the number of source fields that could send notifications or value sets. More... | |
Field * | getSourceField (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... | |
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 MLint & | enableNotificationsCounterState () |
Provides read/write access to the current counter state (see enableNotificationsGlobally(bool) ). More... | |
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 removes 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 that shall be set to the value of this field or that shall be notified only if this field is changed or notified. More... | |
std::vector< Field * > | _sourceFields |
List of (source) fields that will notify this field or that 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 that disables the notification process of field (-sensors) globally. More... | |
Definition at line 26 of file mlListField.h.
|
default |
Default constructor, do not use it.
|
inline |
Constructor; creates a list field with a name
.
Definition at line 33 of file mlListField.h.
|
inline |
Clears the value of this field.
Definition at line 39 of file mlListField.h.
|
inlineoverridevirtual |
Returns the value of the field as string value.
Implements ml::Field.
Definition at line 82 of file mlListField.h.
References T, and ml::ValuePersistence::valueToString().
|
inline |
Returns component value at index index
. index
must be in range.
Definition at line 77 of file mlListField.h.
|
inline |
Returns the value of the field as a boolean.
Definition at line 56 of file mlListField.h.
|
inlineoverridevirtual |
Sets the value of the field to value
.
Implements ml::Field.
Definition at line 104 of file mlListField.h.
References ml::ValuePersistence::stringToValue(), and T.
|
inline |
Sets the field value at index index
to value
.
If the index is greater than the current size, the list of values is expanded accordingly with default values.
Definition at line 60 of file mlListField.h.
|
inline |
Sets the field value to values
.
Definition at line 42 of file mlListField.h.
|
inline |
Returns the number of elements of this fields value.
Definition at line 36 of file mlListField.h.
|
inline |
Sets the field value at index index
to value
, but only touches the field if the new value is different from the old value at that index.
Definition at line 70 of file mlListField.h.
|
inline |
Sets the field value to values
, but only touches the field if the new values are different from the old values.
Definition at line 49 of file mlListField.h.