Field to encapsulate a vector of 5 double values. More...

#include <mlFields.h>

Inheritance diagram for ml::Vector5Field:

Public Member Functions
	Vector5Field ()
	Default constructor, do not use it.
	Vector5Field (const std::string &name)
	Constructor, creates a field with a `name` to manage a vector of 5 double values initialized to (0,0,0,0,0) by default.
void	setStringValue (const std::string &stringValue)
	Sets the value of the field to `stringValue`.
void	setVector5Value (const Vector5 &vectorValue)
	Sets the value of the field to `vectorValue`.
void	updateVector5Value (const Vector5 &vectorValue)
	Sets the value of the field to `vectorValue`, but only touch field if the new value is different from the old value.
void	setVectorValue (const Vector5 &vectorValue)
	Sets the value of the field to `vectorValue`.
std::string	getStringValue () const
	Returns the value of the field as a string value.
const Vector5 &	getVector5Value () const
	Returns the value of the field.
const Vector5 &	getVectorValue () const
	Returns the value of the field.
Deprecated
void	setVec5fValue (const Vector5 &value)
const Vector5 &	getVec5fValue () const
Protected Member Functions
virtual void	setValueFromField (const Field &field)
	Reimplementation from Field which copies the field value more efficiently.

Detailed Description

Field to encapsulate a vector of 5 double values.

Definition at line 1500 of file mlFields.h.

Constructor & Destructor Documentation

ml::Vector5Field::Vector5Field ( )

Default constructor, do not use it.

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

Constructor, creates a field with a name to manage a vector of 5 double values initialized to (0,0,0,0,0) by default.

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

Returns the value of the field as a string value.

setStringValue must be able to reinterpret this returned string correctly.

Implements ml::Field.

const Vector5& ml::Vector5Field::getVec5fValue ( ) const [inline]

Definition at line 1565 of file mlFields.h.

const Vector5& ml::Vector5Field::getVector5Value ( ) const

Returns the value of the field.

const Vector5& ml::Vector5Field::getVectorValue ( ) const [inline]

Returns the value of the field.

Definition at line 1538 of file mlFields.h.

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

Sets the value of the field to stringValue.

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Vector5Field::setVec5fValue ( const Vector5 & value ) [inline]

Definition at line 1562 of file mlFields.h.

void ml::Vector5Field::setVector5Value ( const Vector5 & vectorValue )

Sets the value of the field to vectorValue.

void ml::Vector5Field::setVectorValue ( const Vector5 & vectorValue ) [inline]

Sets the value of the field to vectorValue.

Definition at line 1527 of file mlFields.h.

void ml::Vector5Field::updateVector5Value ( const Vector5 & vectorValue )

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

(NOTE that values must be identical to avoid touching the field!)

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