ML Reference
ml::Vector6Field Class Reference

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

#include <mlFields.h>

Inheritance diagram for ml::Vector6Field:
ml::Field

List of all members.

Public Member Functions

 Vector6Field ()
 Default constructor, do not use it.
 Vector6Field (const std::string &name)
 Constructo, creates a field with a name to manage a vector of 6 double values.
void setStringValue (const std::string &stringValue)
 Sets the value of the field to stringValue.
void setVector6Value (const Vector6 &vectorValue)
 Sets the value of the field to vectorValue.
void updateVector6Value (const Vector6 &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 Vector6 &vectorValue)
 Sets the value of the field to vectorValue.
std::string getStringValue () const
 Returns the value of the field as a string value.
const Vector6getVector6Value () const
 Returns the value of the field.
const Vector6getVectorValue () const
 Returns the value of the field.
Deprecated
void setVec6fValue (const Vector6 &value)
const Vector6getVec6fValue () const
 Vector6Field (const std::string &name, Vector6 *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 a vector of 6 double values.

Definition at line 1587 of file mlFields.h.


Constructor & Destructor Documentation

ml::Vector6Field::Vector6Field ( )

Default constructor, do not use it.

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

Constructo, creates a field with a name to manage a vector of 6 double values.

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

ml::Vector6Field::Vector6Field ( const std::string &  name,
Vector6 valuePtr 
)

Member Function Documentation

std::string ml::Vector6Field::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 Vector6& ml::Vector6Field::getVec6fValue ( ) const [inline]
Deprecated:
Use getVector6Value instead.

Definition at line 1654 of file mlFields.h.

const Vector6& ml::Vector6Field::getVector6Value ( ) const

Returns the value of the field.

const Vector6& ml::Vector6Field::getVectorValue ( ) const [inline]

Returns the value of the field.

Definition at line 1625 of file mlFields.h.

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

Sets the value of the field to stringValue.

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Vector6Field::setVec6fValue ( const Vector6 value) [inline]
Deprecated:
Use setVector6Value instead.

Definition at line 1651 of file mlFields.h.

void ml::Vector6Field::setVector6Value ( const Vector6 vectorValue)

Sets the value of the field to vectorValue.

void ml::Vector6Field::setVectorValue ( const Vector6 vectorValue) [inline]

Sets the value of the field to vectorValue.

Definition at line 1614 of file mlFields.h.

void ml::Vector6Field::updateVector6Value ( const Vector6 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: