ML Reference
ml::Matrix6Field Class Reference

Field encapsulating a 6x6 matrix. More...

#include <mlFields.h>

Inheritance diagram for ml::Matrix6Field:
ml::Field

List of all members.

Public Member Functions

 Matrix6Field (const std::string &name="")
 Constructor, creates a field with a name to manage a 6x6 matrix initialized to the unit matrix by default.
void setStringValue (const std::string &stringValue)
 Sets the field value to stringValue="a11 a12 ... a66".
void setMatrixValue (const Matrix6 &matrixValue)
 Sets the value of the field to matrixValue.
void setMatrix6Value (const Matrix6 &matrixValue)
 Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields.
void updateMatrix6Value (const Matrix6 &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 Matrix6getMatrixValue () const
 Returns the value of the field.
const Matrix6getMatrix6Value () const
 Returns the value of the field; same as getMatrixValue for symmetry to other fields.
Deprecated
void setMat6fValue (const Matrix6 &value)
void setMat6Value (const Matrix6 &value)
const Matrix6getMat6Value () 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 6x6 matrix.

Definition at line 2217 of file mlFields.h.


Constructor & Destructor Documentation

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

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


Member Function Documentation

const Matrix6& ml::Matrix6Field::getMat6Value ( ) const [inline]
Deprecated:
Use getMatrix6Value instead.

Definition at line 2280 of file mlFields.h.

const Matrix6& ml::Matrix6Field::getMatrix6Value ( ) const

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

const Matrix6& ml::Matrix6Field::getMatrixValue ( ) const

Returns the value of the field.

std::string ml::Matrix6Field::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::Matrix6Field::setMat6fValue ( const Matrix6 value) [inline]
Deprecated:
Use setMatrix6Value instead.

Definition at line 2274 of file mlFields.h.

void ml::Matrix6Field::setMat6Value ( const Matrix6 value) [inline]
Deprecated:
Use setMatrix6Value instead.

Definition at line 2277 of file mlFields.h.

void ml::Matrix6Field::setMatrix6Value ( const Matrix6 matrixValue)

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

void ml::Matrix6Field::setMatrixValue ( const Matrix6 matrixValue)

Sets the value of the field to matrixValue.

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

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

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

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Matrix6Field::updateMatrix6Value ( const Matrix6 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: