ML Reference
Public Member Functions | Protected Member Functions
ml::Matrix3Field Class Reference
Fields

Field encapsulating a 3x3 matrix. More...

#include <mlFields.h>

Inheritance diagram for ml::Matrix3Field:
ml::Field

List of all members.

Public Member Functions

 Matrix3Field (const std::string &name="")
 Constructor, creates a field with a name to manage a 3x3 matrix initialized to the unit matrix by default.
void setStringValue (const std::string &stringValue)
 Sets the field value to stringValue="a11 a12 ... a33".
void setMatrixValue (const Matrix3 &matrixValue)
 Sets the value of the field to matrixValue.
void setMatrix3Value (const Matrix3 &matrixValue)
 Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields.
std::string getStringValue () const
 Returns the value of the field as a string value.
const Matrix3 & getMatrixValue () const
 Returns the value of the field.
const Matrix3 & getMatrix3Value () const
 Returns the value of the field; same as getMatrixValue for symmetry to other fields.
Deprecated
void setMat3fValue (const Matrix3 &value)
void setMat3Value (const Matrix3 &value)
const Matrix3 & getMat3Value () 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 3x3 matrix.

Definition at line 1852 of file mlFields.h.

Constructor & Destructor Documentation

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

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

Member Function Documentation

const Matrix3& ml::Matrix3Field::getMat3Value ( ) const [inline]
Deprecated:
Use getMatrix3Value instead.

Definition at line 1908 of file mlFields.h.

const Matrix3& ml::Matrix3Field::getMatrix3Value ( ) const

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

const Matrix3& ml::Matrix3Field::getMatrixValue ( ) const

Returns the value of the field.

std::string ml::Matrix3Field::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::Matrix3Field::setMat3fValue ( const Matrix3 &  value) [inline]
Deprecated:
Use setMatrix3Value instead.

Definition at line 1902 of file mlFields.h.

void ml::Matrix3Field::setMat3Value ( const Matrix3 &  value) [inline]
Deprecated:
Use setMatrix3Value instead.

Definition at line 1905 of file mlFields.h.

void ml::Matrix3Field::setMatrix3Value ( const Matrix3 &  matrixValue)

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

void ml::Matrix3Field::setMatrixValue ( const Matrix3 &  matrixValue)

Sets the value of the field to matrixValue.

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

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

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

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

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