ML Reference
ml::BaseField Class Reference

Field to encapsulate a pointer to an ML base object. More...

#include <mlFields.h>

Inheritance diagram for ml::BaseField:
ml::Field ml::TypedBaseField< T >

Public Member Functions

 BaseField ()
 Implements the runtime type system interface for this class. More...
 
 BaseField (const std::string &name)
 Constructor, creates a field with a name to manage a base pointer. More...
 
 ~BaseField () override
 Destructor. More...
 
void setStringValue (const std::string &stringValue) override
 Sets pointer value from string stringValue. If string cannot be parsed successfully, a NULL pointer is set. More...
 
void setBaseValue (Base *basePointerValue)
 Sets the value of the field to basePointerValue. More...
 
void setBaseValue (const RefCountedBasePtr &value)
 Sets the value from intrusive pointer. More...
 
std::string getStringValue () const override
 Returns the value of the field as a string value. More...
 
BasegetBaseValue () const
 Returns current field value. More...
 
virtual void touchSourceFields (void)
 Touches the source fields. More...
 
void addAllowedType (const RuntimeType *allowedType)
 Add type to list of allowed types. More...
 
template<typename T >
void addAllowedType ()
 Same as above, with template parameter where the Base type can be specified directly. More...
 
template<typename T >
void setBaseValueAndAddAllowedType (T *value)
 convenience routine for setting the base value and its type at the same time. More...
 
template<typename T >
void setBaseValueAndAddAllowedType (const ::boost::intrusive_ptr< T > &value)
 convenience routine for setting the base value and its type at the same time using an intrusive pointer. More...
 
std::vector< const RuntimeType * > getAllowedTypes () const
 Get list of allowed Base types for this field. More...
 
bool hasUnallowedType () const
 return true if the last call of setBaseValue had an unallowed type as argument, getBaseValue will return NULL then More...
 
void setValue (Base *basePointerValue)
 Same as setBaseValue(Base*). More...
 
void setValue (const RefCountedBasePtr &value)
 Same as setBaseValue(const RefCountedBasePtr&). More...
 
BasegetValue () const
 Same as getBaseValue(). More...
 
template<class Type >
Type getTypedValue () const
 Get typed value if the contained base object is derived from the given Type. More...
 
template<class Type >
Type getTypedBaseValue () const
 Get typed value if the contained base object is derived from the given Type. 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...
 
std::string getFullName () const
 Returns "fieldContainerType(instanceName).fieldName" (if field container is available, otherwise only field name is returned). 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...
 

Protected Member Functions

void setValueFromField (const Field &field) override
 Reimplementation from Field which copies the field value more efficiently. 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 remove the given field from the destination list. 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 MLintenableNotificationsCounterState ()
 Provides read/write access to the current counter state (see enableNotificationsGlobally(bool) ). 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 to encapsulate a pointer to an ML base object.

Definition at line 1186 of file mlFields.h.

Constructor & Destructor Documentation

◆ BaseField() [1/2]

ml::BaseField::BaseField ( )

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ BaseField() [2/2]

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

Constructor, creates a field with a name to manage a base pointer.

Default value is NULL.

◆ ~BaseField()

ml::BaseField::~BaseField ( )
override

Destructor.

Member Function Documentation

◆ addAllowedType() [1/2]

template<typename T >
void ml::BaseField::addAllowedType ( )
inline

Same as above, with template parameter where the Base type can be specified directly.

Definition at line 1232 of file mlFields.h.

References addAllowedType().

Referenced by addAllowedType().

◆ addAllowedType() [2/2]

void ml::BaseField::addAllowedType ( const RuntimeType allowedType)

Add type to list of allowed types.

This will set the Base value to NULL if it isn't NULL already and should only be called when creating the BaseField. Calls to setBaseValue (or setStringValue) will only succeed if the given Base object is of one of the allowed types or NULL, or if the list is empty, otherwise NULL will be set instead.

◆ getAllowedTypes()

std::vector<const RuntimeType*> ml::BaseField::getAllowedTypes ( ) const
inline

Get list of allowed Base types for this field.

Definition at line 1246 of file mlFields.h.

◆ getBaseValue()

Base* ml::BaseField::getBaseValue ( ) const

Returns current field value.

◆ getStringValue()

std::string ml::BaseField::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.

◆ getTypedBaseValue()

template<class Type >
Type ml::BaseField::getTypedBaseValue ( ) const
inline

Get typed value if the contained base object is derived from the given Type.

Definition at line 1267 of file mlFields.h.

◆ getTypedValue()

template<class Type >
Type ml::BaseField::getTypedValue ( ) const
inline

Get typed value if the contained base object is derived from the given Type.

Definition at line 1263 of file mlFields.h.

◆ getValue()

Base* ml::BaseField::getValue ( ) const
inline

Same as getBaseValue().

Definition at line 1259 of file mlFields.h.

◆ hasUnallowedType()

bool ml::BaseField::hasUnallowedType ( ) const
inline

return true if the last call of setBaseValue had an unallowed type as argument, getBaseValue will return NULL then

Definition at line 1250 of file mlFields.h.

◆ setBaseValue() [1/2]

void ml::BaseField::setBaseValue ( Base basePointerValue)

Sets the value of the field to basePointerValue.

◆ setBaseValue() [2/2]

void ml::BaseField::setBaseValue ( const RefCountedBasePtr &  value)

Sets the value from intrusive pointer.

◆ setBaseValueAndAddAllowedType() [1/2]

template<typename T >
void ml::BaseField::setBaseValueAndAddAllowedType ( const ::boost::intrusive_ptr< T > &  value)
inline

convenience routine for setting the base value and its type at the same time using an intrusive pointer.

See above methods for details.

Definition at line 1243 of file mlFields.h.

References setBaseValueAndAddAllowedType().

Referenced by setBaseValueAndAddAllowedType().

◆ setBaseValueAndAddAllowedType() [2/2]

template<typename T >
void ml::BaseField::setBaseValueAndAddAllowedType ( T *  value)
inline

convenience routine for setting the base value and its type at the same time.

The type is evaluated at compile-time, so even NULL works if it is cast to the right pointer type! (Or you might specify the type as template argument for NULL arguments!)

Definition at line 1238 of file mlFields.h.

Referenced by ml::FieldContainer::addBaseWithAllowedType().

◆ setStringValue()

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

Sets pointer value from string stringValue. If string cannot be parsed successfully, a NULL pointer is set.

Implements ml::Field.

◆ setValue() [1/2]

void ml::BaseField::setValue ( Base basePointerValue)
inline

Same as setBaseValue(Base*).

Definition at line 1253 of file mlFields.h.

◆ setValue() [2/2]

void ml::BaseField::setValue ( const RefCountedBasePtr &  value)
inline

Same as setBaseValue(const RefCountedBasePtr&).

Definition at line 1256 of file mlFields.h.

◆ setValueFromField()

void ml::BaseField::setValueFromField ( const Field field)
overrideprotectedvirtual

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

◆ touchSourceFields()

virtual void ml::BaseField::touchSourceFields ( void  )
virtual

Touches the source fields.


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