Field to encapsulate an ML vector ImageVector with 6 integer components. More...

#include <mlFields.h>

Inheritance diagram for ml::ImageVectorField:

Public Member Functions
	ImageVectorField ()
	Default constructor, do not use it.
	ImageVectorField (const std::string &name)
	Constructor, creates a field with a `name` to manage a vector of 6 integer values.
void	setStringValue (const std::string &stringValue)
	Sets the value of the field to `stringValue`.
void	setImageVectorValue (const ImageVector &imageVectorValue)
	Sets the value of the field to `imageVectorValue`.
std::string	getStringValue () const
	Returns the value of the field as a string value.
const ImageVector &	getImageVectorValue () const
	Returns the value of the field.
Deprecated
void	setVectorValue (const ImageVector &value)
const ImageVector &	getVectorValue () const
	ImageVectorField (const std::string &name, ImageVector *valuePtr)
Protected Member Functions
virtual void	setValueFromField (const Field &field)
	Reimplementation from Field which copies the field value more efficiently.

Detailed Description

Field to encapsulate an ML vector ImageVector with 6 integer components.

Definition at line 2271 of file mlFields.h.

Constructor & Destructor Documentation

ml::ImageVectorField::ImageVectorField ( )

Default constructor, do not use it.

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

Constructor, creates a field with a name to manage a vector of 6 integer values.

Default value is (0,0,0, 0,0,0).

ml::ImageVectorField::ImageVectorField	(	const std::string &	name,
		ImageVector *	valuePtr
	)

const ImageVector& ml::ImageVectorField::getImageVectorValue ( ) const

Returns the value of the field.

std::string ml::ImageVectorField::getStringValue ( ) const [virtual]

Returns the value of the field as a string value.

Implements ml::Field.

const ImageVector& ml::ImageVectorField::getVectorValue ( ) const [inline]

Definition at line 2323 of file mlFields.h.

void ml::ImageVectorField::setImageVectorValue ( const ImageVector & imageVectorValue )

Sets the value of the field to imageVectorValue.

void ml::ImageVectorField::setStringValue ( const std::string & stringValue ) [virtual]

Sets the value of the field to stringValue.

Implements ml::Field.

virtual void ml::ImageVectorField::setValueFromField ( const Field & field ) [protected, virtual]

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::ImageVectorField::setVectorValue ( const ImageVector & value ) [inline]

Definition at line 2320 of file mlFields.h.

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