Field encapsulating a 5x5 matrix. More...

#include <mlFields.h>

Inheritance diagram for ml::Matrix5Field:

Public Member Functions
	Matrix5Field (const std::string &name="")
	Constructor, creates a field with a `name` to manage a 5x5 matrix initialized to the unit matrix by default.
void	setStringValue (const std::string &stringValue)
	Sets the field value to `stringValue="a11 a12 ... a55"`.
void	setMatrixValue (const Matrix5 &matrixValue)
	Sets the value of the field to `matrixValue`.
void	setMatrix5Value (const Matrix5 &matrixValue)
	Sets the value of the field to `matrixValue`; same as setMatrixValue for symmetry to other fields.
void	updateMatrix5Value (const Matrix5 &matrixValue)
	Sets the value of the field to `matrixValue`, but only touch field if the new value is different from the old value.
std::string	getStringValue () const
	Returns the value of the field as a string value.
const Matrix5 &	getMatrixValue () const
	Returns the value of the field.
const Matrix5 &	getMatrix5Value () const
	Returns the value of the field; same as getMatrixValue for symmetry to other fields.
Deprecated
void	setMat5fValue (const Matrix5 &value)
void	setMat5Value (const Matrix5 &value)
const Matrix5 &	getMat5Value () const
Protected Member Functions
virtual void	setValueFromField (const Field &field)
	Reimplementation from Field which copies the field value more efficiently.

Detailed Description

Field encapsulating a 5x5 matrix.

Definition at line 2132 of file mlFields.h.

Constructor & Destructor Documentation

ml::Matrix5Field::Matrix5Field ( const std::string & name = "" )

Constructor, creates a field with a name to manage a 5x5 matrix initialized to the unit matrix by default.

const Matrix5& ml::Matrix5Field::getMat5Value ( ) const [inline]

Definition at line 2194 of file mlFields.h.

const Matrix5& ml::Matrix5Field::getMatrix5Value ( ) const

Returns the value of the field; same as getMatrixValue for symmetry to other fields.

const Matrix5& ml::Matrix5Field::getMatrixValue ( ) const

Returns the value of the field.

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

void ml::Matrix5Field::setMat5fValue ( const Matrix5 & value ) [inline]

Definition at line 2188 of file mlFields.h.

void ml::Matrix5Field::setMat5Value ( const Matrix5 & value ) [inline]

Definition at line 2191 of file mlFields.h.

void ml::Matrix5Field::setMatrix5Value ( const Matrix5 & matrixValue )

Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields.

void ml::Matrix5Field::setMatrixValue ( const Matrix5 & matrixValue )

Sets the value of the field to matrixValue.

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

Sets the field value to stringValue="a11 a12 ... a55".

If less than 25 valid numbers can be scanned in string then all components are set to 0.

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Matrix5Field::updateMatrix5Value ( const Matrix5 & matrixValue )

Sets the value of the field to matrixValue, 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: