ML Reference
ml::StringField Class Reference
Fields

#include <mlFields.h>

Inheritance diagram for ml::StringField:
ml::Field

Public Member Functions

 StringField ()=default
 Implements the runtime type system interface for this class.
 StringField (const std::string &name)
void setStringValue (const std::string &stringValue) override
 Sets value of the field to stringValue.
void updateStringValue (const std::string &stringValue)
std::string getStringValue () const override
void setValue (const std::string &stringValue)
 Same as setStringValue().
void updateValue (const std::string &stringValue)
 Same as updateStringValue().
std::string getValue () const
 Same as getStringValue().
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 ()

Additional Inherited Members

static void enableNotificationsGlobally (bool flag)
static bool areNotificationsEnabledGlobally ()
static MLint & enableNotificationsCounterState ()
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.
virtual void setValueFromField (const Field &field)
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 string value.

Definition at line 552 of file mlFields.h.

Constructor & Destructor Documentation

◆ StringField() [1/2]

ml::StringField::StringField ( )
default

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ StringField() [2/2]

ml::StringField::StringField ( const std::string & name)
explicit

Constructor; creates a field with a name to manage a string value.

Member Function Documentation

◆ getStringValue()

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

std::string ml::StringField::getValue ( ) const
inline

Same as getStringValue().

Definition at line 584 of file mlFields.h.

References ml::Field::getStringValue().

◆ setStringValue()

void ml::StringField::setStringValue ( const std::string & stringValue)
overridevirtual

Sets value of the field to stringValue.

Implements ml::Field.

◆ setValue()

void ml::StringField::setValue ( const std::string & stringValue)
inline

Same as setStringValue().

Definition at line 578 of file mlFields.h.

References ml::Field::setStringValue().

◆ updateStringValue()

void ml::StringField::updateStringValue ( const std::string & stringValue)

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

Referenced by updateValue().

◆ updateValue()

void ml::StringField::updateValue ( const std::string & stringValue)
inline

Same as updateStringValue().

Definition at line 581 of file mlFields.h.

References updateStringValue().

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