ml::FieldContainer Class Reference

Defines the class FieldContainer to encapsulate a vector of fields for (see class Field). More...

#include <mlFieldContainer.h>

Inheritance diagram for ml::FieldContainer:

List of all members.

Public Member Functions
	FieldContainer ()
	Constructor.
virtual	~FieldContainer ()
	Destructor: Deletes all added fields.
Field *	addField (const char *name, const char *type, const char *value)
	Adds a new field with name name, type type and value value (coded as string) to the container.
Field *	addField (Field *field)
	Adds a field, the ownership of the field is passed to the FieldContainer.
BoolField *	addBool (const char *name)
	Creates a BoolField with name and adds it to the container. Default value is false.
BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with name and adds it to the container.
IntField *	addInt (const char *name)
	Creates an IntField with name and adds it to the container. Default value is 0.
IntField *	addInt (const char *name, MLint value)
	Creates an IntField with name and adds it to the container.
EnumField *	addEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems)
	Creates an EnumField field with name and adds it to the container.
EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
	Creates an EnumField field with name and adds it to the container.
FloatField *	addFloat (const char *name)
	Creates a FloatField with name and adds it to the container. Default value is 0.f.
FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with name and adds it to the container.
ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with name and adds it to the container. Default value is 0.f.
ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with name and adds it to the container.
DoubleField *	addDouble (const char *name)
	Creates a DoubleField with name and adds it to the container. Default value is 0.
DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with name and adds it to the container.
LongDoubleField *	addLongDouble (const char *name)
	Creates a LongDoubleField with name and adds it to the container. Default value is 0.
LongDoubleField *	addLongDouble (const char *name, MLldouble value)
	Creates a LongDoubleField with name and adds it to the container.
StringField *	addString (const char *name)
	Creates a StringField with name and adds it to the container. Default value is empty string.
StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with name and adds it to the container.
NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with name and adds it to the container.
BaseField *	addBase (const char *name)
	Creates a Base field with name and adds it to the container. Default value is NULL.
BaseField *	addBase (const char *name, Base *value)
	Creates a Base field with name and adds it to the container.
SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with name and adds it to the container. Default value is NULL.
SoNodeField *	addSoNode (const char *name, SoNode *value)
	Creates a SoNodeField with name and adds it to the container.
PointerField *	addPointer (const char *name)
	Creates a PointerField with name and adds it to the container.
Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with name and adds it to the container.
Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with name and adds it to the container.
Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with name and adds it to the container.
Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with name and adds it to the container.
Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with name and adds it to the container.
Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with name and adds it to the container.
Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with name and adds it to the container.
Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with name and adds it to the container.
Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with name and adds it to the container.
Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with name and adds it to the container.
Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with name and adds it to the container.
Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with name and adds it to the container.
Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with name and adds it to the container.
Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with name and adds it to the container.
Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with name and adds it to the container.
ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with name and adds it to the container.
ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with name and adds it to the container.
ImageVectorField *	addImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
	Creates a ImageVectorField with name and adds it to the container.
SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with name and adds it to the container.
SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with name and adds it to the container.
SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with name and adds it to the container.
SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with name and adds it to the container.
ColorField *	addColor (const char *name)
	Creates a ColorField with name and adds it to the container.
ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with name and adds it to the container.
ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with name and adds it to the container.
PlaneField *	addPlane (const char *name)
	Creates a PlaneField with name and adds it to the container.
PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with name and adds it to the container.
PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with name and adds it to the container.
RotationField *	addRotation (const char *name)
	Creates a RotationField with name and adds it to the container.
RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with name and adds it to the container.
Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with name and adds it to the container.
Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with name and adds it to the container.
Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with name and adds it to the container.
Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with name and adds it to the container.
Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with name and adds it to the container.
Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with name and adds it to the container.
Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with name and adds it to the container.
Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with name and adds it to the container.
Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with name and adds it to the container.
Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with name and adds it to the container.
MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with name and adds it to the container.
MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with name and adds it to the container.
MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with name and adds it to the container.
MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with name and adds it to the container.
UniversalTypeField *	addUniversalType (const char *name)
	Creates a UniversalTypeField field with name and adds it to the container.
size_t	getNumFields () const
	Returns the number of added fields.
bool	hasField (const std::string &name) const
	Returns true if the field with name name exists; otherwise false is returned.
Field *	getField (const std::string &name) const
	Returns the pointer to the field with name name.
Field *	getField (MLint index) const
	Returns pointer of field at index if it exists. If not, -1 is returned.
MLint	getFieldIndex (Field *field) const
	Returns index of field if it exists. If not, -1 is returned.
void	setFieldStringValue (const std::string &name, const std::string &value)
	Sets the value of the field with name if it exists.
std::string	getFieldStringValue (const std::string &name) const
	Returns the string value of the field with name if it is found.
virtual void	activateAttachments ()
	Reactivates notification handling, i.e., all fields of this module will send notifications again to attached sensors and fields if their value is set or changed.
virtual void	deactivateAttachments ()
	Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed.
DeprecatedVirtuals
These methods can no be inside of ML_DEPRECATED, since they would change binary compatibility.
virtual InputConnectorField *	addInputConnector (const char *, Module *, MLint)
virtual OutputConnectorField *	addOutputConnector (const char *, Module *, MLint)
Deprecated
Methods have a value pointer in their parameter list.
InputConnectorField *	addInputConnector (Module *module, MLint i)
OutputConnectorField *	addOutputConnector (Module *module, MLint i)
Vector2Field *	addVec2f (const char *name)
Vector2Field *	addDeprecatedVec2f (const char *name, Vector2 *var0)
Vector3Field *	addVec3f (const char *name)
Vector3Field *	addDeprecatedVec3f (const char *name, Vector3 *var0)
Vector4Field *	addVec4f (const char *name)
Vector4Field *	addDeprecatedVec4f (const char *name, Vector4 *var0)
Vector5Field *	addVec5f (const char *name)
Vector6Field *	addVec6f (const char *name)
Vector6Field *	addDeprecatedVec6f (const char *name, Vector6 *var0)
Vector10Field *	addVec10f (const char *name)
ImageVectorField *	addVector (const char *name)
ImageVectorField *	addDeprecatedVector (const char *name, ImageVector *var0)
SubImageBoxField *	addSubImgBox (const char *name)
SubImageBoxField *	addDeprecatedSubImgBox (const char *name, SubImageBox *var0)
SubImageBoxdField *	addSubImgBoxf (const char *name)
SubImageBoxdField *	addDeprecatedSubImgBoxf (const char *name, SubImageBoxd *var0)
Matrix2Field *	addMat2 (const char *name)
Matrix3Field *	addMat3 (const char *name)
Matrix4Field *	addMat4 (const char *name)
Matrix5Field *	addMat5 (const char *name)
Matrix6Field *	addMat6 (const char *name)
BoolField *	addDeprecatedBool (const char *name, bool *var)
IntField *	addDeprecatedInt (const char *name, MLint *var)
ToggleField *	addDeprecatedToggle (const char *name)
ToggleField *	addDeprecatedToggle (const char *name, int *var)
EnumField *	addDeprecatedEnum (const char *name, const char *const *enumNames, MLint enumNum, int *var)
FloatField *	addDeprecatedFloat (const char *name, float *var)
ProgressField *	addDeprecatedProgress (const char *name, float *var)
DoubleField *	addDeprecatedDouble (const char *name, double *var)
Vector2Field *	addDeprecatedVector2 (const char *name, Vector2 *var0)
Vector3Field *	addDeprecatedVector3 (const char *name, Vector3 *var0)
Vector4Field *	addDeprecatedVector4 (const char *name, Vector4 *var0)
Vector6Field *	addDeprecatedVector6 (const char *name, Vector6 *var0)
ImageVectorField *	addDeprecatedImageVector (const char *name, ImageVector *var0)
SubImageBoxField *	addDeprecatedSubImageBox (const char *name, SubImageBox *var0)
SubImageBoxdField *	addDeprecatedSubImageBoxd (const char *name, SubImageBoxd *var0)
ColorField *	addDeprecatedColor (const char *name, Vector3 *var0)
MatrixField *	addDeprecatedMatrix (const char *name, Matrix4 *mat)
MLDataTypeField *	addDeprecatedMLDataType (const char *name, MLDataType *dt)
Protected Member Functions
virtual void	handleNotificationInternal (Field *, FieldSensor::Strength)
	Called when field has changed.
Friends
class	Field

---

Detailed Description

Defines the class FieldContainer to encapsulate a vector of fields for (see class Field).

It is usually used as a parameter interface for the Module class. In its constructor a Module usually adds all the interface parameters to its field container.

Definition at line 71 of file mlFieldContainer.h.

---

Constructor & Destructor Documentation

ml::FieldContainer::FieldContainer

(

)

Constructor.

virtual ml::FieldContainer::~FieldContainer

(

)

[virtual]

Destructor: Deletes all added fields.

---

Member Function Documentation

virtual void ml::FieldContainer::activateAttachments

(

)

[inline, virtual]

Reactivates notification handling, i.e., all fields of this module will send notifications again to attached sensors and fields if their value is set or changed.

Overload this method to be notified when e.g., a module load or clone process has finished. During module load and clone processes the field values are restored but handleNotification calls are blocked so that the module cannot update itself to those field changes (see deactivateAttachments()). When activateAttachment is called, the module can have a look at its new field settings and update its internal state to the new field states. Note that the overloaded method has to be called; otherwise notification handling is not activated correctly.

Definition at line 301 of file mlFieldContainer.h.

BaseField* ml::FieldContainer::addBase

(

const char *

name

)

Creates a Base field with name and adds it to the container. Default value is NULL.

BaseField* ml::FieldContainer::addBase	(	const char *	name,
		Base *	value
	)

Creates a Base field with name and adds it to the container.

BoolField* ml::FieldContainer::addBool

(

const char *

name

)

Creates a BoolField with name and adds it to the container. Default value is false.

BoolField* ml::FieldContainer::addBool	(	const char *	name,
		bool	value
	)

Creates a BoolField with name and adds it to the container.

ColorField* ml::FieldContainer::addColor

(

const char *

name

)

Creates a ColorField with name and adds it to the container.

ColorField* ml::FieldContainer::addColor	(	const char *	name,
		float	r,
		float	g,
		float	b
	)

Creates a ColorField with name and adds it to the container.

ColorField* ml::FieldContainer::addColor	(	const char *	name,
		const Vector3 &	value
	)

Creates a ColorField with name and adds it to the container.

BoolField* ml::FieldContainer::addDeprecatedBool	(	const char *	name,
		bool *	var
	)

Deprecated:

Use addBool(const char* name) instead.

ColorField* ml::FieldContainer::addDeprecatedColor	(	const char *	name,
		Vector3 *	var0
	)

Deprecated:

Use addColor(const char* name) instead.

DoubleField* ml::FieldContainer::addDeprecatedDouble	(	const char *	name,
		double *	var
	)

Deprecated:

Use addDouble(const char* name) instead.

EnumField* ml::FieldContainer::addDeprecatedEnum	(	const char *	name,
		const char *const *	enumNames,
		MLint	enumNum,
		int *	var
	)

Deprecated:

Use addEnum(const char* name, const char* const * enumNames, MLint enumNum) instead.

FloatField* ml::FieldContainer::addDeprecatedFloat	(	const char *	name,
		float *	var
	)

Deprecated:

Use addFloat(const char* name) instead.

ImageVectorField* ml::FieldContainer::addDeprecatedImageVector	(	const char *	name,
		ImageVector *	var0
	)

Deprecated:

Use addImageVector(const char* name) instead.

IntField* ml::FieldContainer::addDeprecatedInt	(	const char *	name,
		MLint *	var
	)

Deprecated:

Use addInt(const char* name) instead.

MatrixField* ml::FieldContainer::addDeprecatedMatrix	(	const char *	name,
		Matrix4 *	mat
	)

Deprecated:

Use addMatrix(const char* name) instead.

MLDataTypeField* ml::FieldContainer::addDeprecatedMLDataType	(	const char *	name,
		MLDataType *	dt
	)

Deprecated:

Use addMLDataType(const char* name) instead.

ProgressField* ml::FieldContainer::addDeprecatedProgress	(	const char *	name,
		float *	var
	)

Deprecated:

Use addProgress(const char* name) instead.

SubImageBoxField* ml::FieldContainer::addDeprecatedSubImageBox	(	const char *	name,
		SubImageBox *	var0
	)

Deprecated:

Use addSubImageBox(const char* name) instead.

SubImageBoxdField* ml::FieldContainer::addDeprecatedSubImageBoxd	(	const char *	name,
		SubImageBoxd *	var0
	)

Deprecated:

Use addSubImageBoxd(const char* name) instead.

SubImageBoxField* ml::FieldContainer::addDeprecatedSubImgBox	(	const char *	name,
		SubImageBox *	var0
	)		[inline]

Definition at line 395 of file mlFieldContainer.h.

SubImageBoxdField* ml::FieldContainer::addDeprecatedSubImgBoxf	(	const char *	name,
		SubImageBoxd *	var0
	)		[inline]

Definition at line 399 of file mlFieldContainer.h.

ToggleField* ml::FieldContainer::addDeprecatedToggle

(

const char *

name

)

Deprecated:

Use addBool(const char* name) instead.

ToggleField* ml::FieldContainer::addDeprecatedToggle	(	const char *	name,
		int *	var
	)

Deprecated:

Use addBool(const char* name) instead.

Vector2Field* ml::FieldContainer::addDeprecatedVec2f	(	const char *	name,
		Vector2 *	var0
	)		[inline]

Definition at line 369 of file mlFieldContainer.h.

Vector3Field* ml::FieldContainer::addDeprecatedVec3f	(	const char *	name,
		Vector3 *	var0
	)		[inline]

Definition at line 373 of file mlFieldContainer.h.

Vector4Field* ml::FieldContainer::addDeprecatedVec4f	(	const char *	name,
		Vector4 *	var0
	)		[inline]

Definition at line 377 of file mlFieldContainer.h.

Vector6Field* ml::FieldContainer::addDeprecatedVec6f	(	const char *	name,
		Vector6 *	var0
	)		[inline]

Definition at line 384 of file mlFieldContainer.h.

ImageVectorField* ml::FieldContainer::addDeprecatedVector	(	const char *	name,
		ImageVector *	var0
	)		[inline]

Definition at line 391 of file mlFieldContainer.h.

Vector2Field* ml::FieldContainer::addDeprecatedVector2	(	const char *	name,
		Vector2 *	var0
	)

Deprecated:

Use addVector2(const char* name) instead.

Vector3Field* ml::FieldContainer::addDeprecatedVector3	(	const char *	name,
		Vector3 *	var0
	)

Deprecated:

Use addVector3(const char* name) instead.

Vector4Field* ml::FieldContainer::addDeprecatedVector4	(	const char *	name,
		Vector4 *	var0
	)

Deprecated:

Use addVector4(const char* name) instead.

Vector6Field* ml::FieldContainer::addDeprecatedVector6	(	const char *	name,
		Vector6 *	var0
	)

Deprecated:

Use addVector6(const char* name) instead.

DoubleField* ml::FieldContainer::addDouble

(

const char *

name

)

Creates a DoubleField with name and adds it to the container. Default value is 0.

DoubleField* ml::FieldContainer::addDouble	(	const char *	name,
		double	value
	)

Creates a DoubleField with name and adds it to the container.

EnumField* ml::FieldContainer::addEnum	(	const char *	name,
		const std::vector< std::string > &	enumerationItemNames
	)

Creates an EnumField field with name and adds it to the container.

The names of the enum entries are defined by the string vector enumerationItemNames. The value range for the enum value is [0, enumerationItemNames.size()-1].

EnumField* ml::FieldContainer::addEnum	(	const char *	name,
		const char *const *	enumerationItemNames,
		MLint	numEnumerationItems
	)

Creates an EnumField field with name and adds it to the container.

The names of the enum entries are defined by the string array enumerationItemNames. It MUST have at least numEnumerationItems entries. The value range for the enum value is [0, numEnumerationItems-1].

Field* ml::FieldContainer::addField

(

Field *

field

)

Adds a field, the ownership of the field is passed to the FieldContainer.

Field* ml::FieldContainer::addField	(	const char *	name,
		const char *	type,
		const char *	value
	)

Adds a new field with name name, type type and value value (coded as string) to the container.

The field manages its memory itself, i.e., it copies the value from the string constant. The ownership of the returned field stays with the FieldContainer.

FloatField* ml::FieldContainer::addFloat

(

const char *

name

)

Creates a FloatField with name and adds it to the container. Default value is 0.f.

FloatField* ml::FieldContainer::addFloat	(	const char *	name,
		float	value
	)

Creates a FloatField with name and adds it to the container.

ImageVectorField* ml::FieldContainer::addImageVector

(

const char *

name

)

Creates a ImageVectorField with name and adds it to the container.

ImageVectorField* ml::FieldContainer::addImageVector	(	const char *	name,
		const ImageVector &	value
	)

Creates a ImageVectorField with name and adds it to the container.

ImageVectorField* ml::FieldContainer::addImageVector	(	const char *	name,
		MLint	x,
		MLint	y,
		MLint	z,
		MLint	c,
		MLint	t,
		MLint	u
	)

Creates a ImageVectorField with name and adds it to the container.

virtual InputConnectorField* ml::FieldContainer::addInputConnector	(	const char *	,
		Module *	,
		MLint
	)		[inline, virtual]

Deprecated:

Use Module::addInputImage() instead.

Reimplemented in ml::Module.

Definition at line 343 of file mlFieldContainer.h.

InputConnectorField* ml::FieldContainer::addInputConnector	(	Module *	module,
		MLint	i
	)

Deprecated:

Use Module::addInputImage() instead.

IntField* ml::FieldContainer::addInt

(

const char *

name

)

Creates an IntField with name and adds it to the container. Default value is 0.

IntField* ml::FieldContainer::addInt	(	const char *	name,
		MLint	value
	)

Creates an IntField with name and adds it to the container.

LongDoubleField* ml::FieldContainer::addLongDouble	(	const char *	name,
		MLldouble	value
	)

Creates a LongDoubleField with name and adds it to the container.

LongDoubleField* ml::FieldContainer::addLongDouble

(

const char *

name

)

Creates a LongDoubleField with name and adds it to the container. Default value is 0.

Matrix2Field* ml::FieldContainer::addMat2

(

const char *

name

)

[inline]

Deprecated:

Use addMatrix2 instead.

Definition at line 402 of file mlFieldContainer.h.

Matrix3Field* ml::FieldContainer::addMat3

(

const char *

name

)

[inline]

Deprecated:

Use addMatrix3 instead.

Definition at line 405 of file mlFieldContainer.h.

Matrix4Field* ml::FieldContainer::addMat4

(

const char *

name

)

[inline]

Deprecated:

Use addMatrix4 instead.

Definition at line 408 of file mlFieldContainer.h.

Matrix5Field* ml::FieldContainer::addMat5

(

const char *

name

)

[inline]

Deprecated:

Use addMatrix5 instead.

Definition at line 411 of file mlFieldContainer.h.

Matrix6Field* ml::FieldContainer::addMat6

(

const char *

name

)

[inline]

Deprecated:

Use addMatrix6 instead.

Definition at line 414 of file mlFieldContainer.h.

MatrixField* ml::FieldContainer::addMatrix

(

const char *

name

)

Creates a MatrixField with name and adds it to the container.

MatrixField* ml::FieldContainer::addMatrix	(	const char *	name,
		const Matrix4 &	value
	)

Creates a MatrixField with name and adds it to the container.

Matrix2Field* ml::FieldContainer::addMatrix2	(	const char *	name,
		const Matrix2 &	value
	)

Creates a Matrix2Field with name and adds it to the container.

Matrix2Field* ml::FieldContainer::addMatrix2

(

const char *

name

)

Creates a Matrix2Field with name and adds it to the container.

Matrix3Field* ml::FieldContainer::addMatrix3	(	const char *	name,
		const Matrix3 &	value
	)

Creates a Matrix3Field with name and adds it to the container.

Matrix3Field* ml::FieldContainer::addMatrix3

(

const char *

name

)

Creates a Matrix3Field with name and adds it to the container.

Matrix4Field* ml::FieldContainer::addMatrix4

(

const char *

name

)

Creates a Matrix4Field with name and adds it to the container.

Matrix4Field* ml::FieldContainer::addMatrix4	(	const char *	name,
		const Matrix4 &	value
	)

Creates a Matrix4Field with name and adds it to the container.

Matrix5Field* ml::FieldContainer::addMatrix5

(

const char *

name

)

Creates a Matrix5Field with name and adds it to the container.

Matrix5Field* ml::FieldContainer::addMatrix5	(	const char *	name,
		const Matrix5 &	value
	)

Creates a Matrix5Field with name and adds it to the container.

Matrix6Field* ml::FieldContainer::addMatrix6	(	const char *	name,
		const Matrix6 &	value
	)

Creates a Matrix6Field with name and adds it to the container.

Matrix6Field* ml::FieldContainer::addMatrix6

(

const char *

name

)

Creates a Matrix6Field with name and adds it to the container.

MLDataTypeField* ml::FieldContainer::addMLDataType

(

const char *

name

)

Creates a MTDataTypeField with name and adds it to the container.

MLDataTypeField* ml::FieldContainer::addMLDataType	(	const char *	name,
		MLDataType	value
	)

Creates a MTDataTypeField with name and adds it to the container.

NotifyField* ml::FieldContainer::addNotify

(

const char *

name

)

Creates a NotifyField field with name and adds it to the container.

virtual OutputConnectorField* ml::FieldContainer::addOutputConnector	(	const char *	,
		Module *	,
		MLint
	)		[inline, virtual]

Deprecated:

Use Module::addOutputImage() instead.

Reimplemented in ml::Module.

Definition at line 347 of file mlFieldContainer.h.

OutputConnectorField* ml::FieldContainer::addOutputConnector	(	Module *	module,
		MLint	i
	)

Deprecated:

Use Module::addOutputImage() instead.

PlaneField* ml::FieldContainer::addPlane

(

const char *

name

)

Creates a PlaneField with name and adds it to the container.

PlaneField* ml::FieldContainer::addPlane	(	const char *	name,
		double	f0,
		double	f1,
		double	f2,
		double	f3
	)

Creates a PlaneField with name and adds it to the container.

PlaneField* ml::FieldContainer::addPlane	(	const char *	name,
		const Plane &	value
	)

Creates a PlaneField with name and adds it to the container.

PointerField* ml::FieldContainer::addPointer

(

const char *

name

)

Creates a PointerField with name and adds it to the container.

ProgressField* ml::FieldContainer::addProgress

(

const char *

name

)

Creates a float ProgressField with name and adds it to the container. Default value is 0.f.

ProgressField* ml::FieldContainer::addProgress	(	const char *	name,
		float	value
	)

Creates a float ProgressField with name and adds it to the container.

RotationField* ml::FieldContainer::addRotation	(	const char *	name,
		const Rotation &	value
	)

Creates a RotationField with name and adds it to the container.

RotationField* ml::FieldContainer::addRotation

(

const char *

name

)

Creates a RotationField with name and adds it to the container.

SoNodeField* ml::FieldContainer::addSoNode

(

const char *

name

)

Creates a SoNodeField with name and adds it to the container. Default value is NULL.

SoNodeField* ml::FieldContainer::addSoNode	(	const char *	name,
		SoNode *	value
	)

Creates a SoNodeField with name and adds it to the container.

StringField* ml::FieldContainer::addString

(

const char *

name

)

Creates a StringField with name and adds it to the container. Default value is empty string.

StringField* ml::FieldContainer::addString	(	const char *	name,
		const std::string &	value
	)

Creates a StringField with name and adds it to the container.

SubImageBoxField* ml::FieldContainer::addSubImageBox	(	const char *	name,
		const SubImageBox &	value
	)

Creates a SubImageBoxField with name and adds it to the container.

SubImageBoxField* ml::FieldContainer::addSubImageBox

(

const char *

name

)

Creates a SubImageBoxField with name and adds it to the container.

SubImageBoxdField* ml::FieldContainer::addSubImageBoxd

(

const char *

name

)

Creates a SubImageBoxd field with name and adds it to the container.

SubImageBoxdField* ml::FieldContainer::addSubImageBoxd	(	const char *	name,
		const SubImageBoxd &	value
	)

Creates a SubImageBoxd field with name and adds it to the container.

SubImageBoxField* ml::FieldContainer::addSubImgBox

(

const char *

name

)

[inline]

Deprecated:

Use addSubImageBox instead.

Definition at line 394 of file mlFieldContainer.h.

SubImageBoxdField* ml::FieldContainer::addSubImgBoxf

(

const char *

name

)

[inline]

Deprecated:

Use addSubImageBoxd instead.

Definition at line 398 of file mlFieldContainer.h.

UniversalTypeField* ml::FieldContainer::addUniversalType

(

const char *

name

)

Creates a UniversalTypeField field with name and adds it to the container.

Vector10Field* ml::FieldContainer::addVec10f

(

const char *

name

)

[inline]

Deprecated:

Use addVector10 instead.

Definition at line 387 of file mlFieldContainer.h.

Vector2Field* ml::FieldContainer::addVec2f

(

const char *

name

)

[inline]

Deprecated:

Use addVector2 instead.

Definition at line 368 of file mlFieldContainer.h.

Vector3Field* ml::FieldContainer::addVec3f

(

const char *

name

)

[inline]

Deprecated:

Use addVector3 instead.

Definition at line 372 of file mlFieldContainer.h.

Vector4Field* ml::FieldContainer::addVec4f

(

const char *

name

)

[inline]

Deprecated:

Use addVector4 instead.

Definition at line 376 of file mlFieldContainer.h.

Vector5Field* ml::FieldContainer::addVec5f

(

const char *

name

)

[inline]

Deprecated:

Use addVector5 instead.

Definition at line 380 of file mlFieldContainer.h.

Vector6Field* ml::FieldContainer::addVec6f

(

const char *

name

)

[inline]

Deprecated:

Use addVector6 instead.

Definition at line 383 of file mlFieldContainer.h.

ImageVectorField* ml::FieldContainer::addVector

(

const char *

name

)

[inline]

Deprecated:

Use addImageVector instead.

Definition at line 390 of file mlFieldContainer.h.

Vector10Field* ml::FieldContainer::addVector10	(	const char *	name,
		const Vector10 &	value
	)

Creates a Vector10Field with name and adds it to the container.

Vector10Field* ml::FieldContainer::addVector10

(

const char *

name

)

Creates a Vector10Field with name and adds it to the container.

Vector2Field* ml::FieldContainer::addVector2	(	const char *	name,
		double	x,
		double	y
	)

Creates a Vector2Field with name and adds it to the container.

Vector2Field* ml::FieldContainer::addVector2

(

const char *

name

)

Creates a Vector2Field with name and adds it to the container.

Vector2Field* ml::FieldContainer::addVector2	(	const char *	name,
		const Vector2 &	value
	)

Creates a Vector2Field with name and adds it to the container.

Vector3Field* ml::FieldContainer::addVector3	(	const char *	name,
		const Vector3 &	value
	)

Creates a Vector3Field with name and adds it to the container.

Vector3Field* ml::FieldContainer::addVector3

(

const char *

name

)

Creates a Vector3Field with name and adds it to the container.

Vector3Field* ml::FieldContainer::addVector3	(	const char *	name,
		double	x,
		double	y,
		double	z
	)

Creates a Vector3Field with name and adds it to the container.

Vector4Field* ml::FieldContainer::addVector4	(	const char *	name,
		double	x,
		double	y,
		double	z,
		double	w
	)

Creates a Vector4Field with name and adds it to the container.

Vector4Field* ml::FieldContainer::addVector4

(

const char *

name

)

Creates a Vector4Field with name and adds it to the container.

Vector4Field* ml::FieldContainer::addVector4	(	const char *	name,
		const Vector4 &	value
	)

Creates a Vector4Field with name and adds it to the container.

Vector5Field* ml::FieldContainer::addVector5

(

const char *

name

)

Creates a Vector5Field with name and adds it to the container.

Vector5Field* ml::FieldContainer::addVector5	(	const char *	name,
		const Vector5 &	value
	)

Creates a Vector5Field with name and adds it to the container.

Vector6Field* ml::FieldContainer::addVector6

(

const char *

name

)

Creates a Vector6Field with name and adds it to the container.

Vector6Field* ml::FieldContainer::addVector6	(	const char *	name,
		const Vector6 &	value
	)

Creates a Vector6Field with name and adds it to the container.

virtual void ml::FieldContainer::deactivateAttachments

(

)

[inline, virtual]

Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed.

This normally indicates that a field restore process (due to a module load or clone) has been started and many field values will be set. During that process no field notifications are sent, i.e., handleNotification is not called. The process then is completed by the call of activateAttachments which can be used to update the internal module state to the new field state then. Note that the overloaded method has to be called; otherwise notification handling is not deactivated correctly. See activateAttachments().

Definition at line 312 of file mlFieldContainer.h.

Field* ml::FieldContainer::getField

(

const std::string &

name

)

const

Returns the pointer to the field with name name.

A warning is printed if not found and NULL is returned.

Field* ml::FieldContainer::getField

(

MLint

index

)

const

Returns pointer of field at index if it exists. If not, -1 is returned.

MLint ml::FieldContainer::getFieldIndex

(

Field *

field

)

const

Returns index of field if it exists. If not, -1 is returned.

std::string ml::FieldContainer::getFieldStringValue

(

const std::string &

name

)

const

Returns the string value of the field with name if it is found.

Otherwise a pointer to the empty temporary string "" is returned and a warning is printed.

size_t ml::FieldContainer::getNumFields

(

)

const

Returns the number of added fields.

virtual void ml::FieldContainer::handleNotificationInternal	(	Field *	,
		FieldSensor::Strength
	)		[inline, protected, virtual]

Called when field has changed.

Reimplemented in ml::Module.

Definition at line 331 of file mlFieldContainer.h.

bool ml::FieldContainer::hasField

(

const std::string &

name

)

const

Returns true if the field with name name exists; otherwise false is returned.

void ml::FieldContainer::setFieldStringValue	(	const std::string &	name,
		const std::string &	value
	)

Sets the value of the field with name if it exists.

Otherwise a warning is printed.

---

Friends And Related Function Documentation

friend class Field [friend]

Definition at line 328 of file mlFieldContainer.h.

---

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

• MeVis/Foundation/Sources/ML/include/mlFieldContainer.h