ML Reference
ml::Vector5Field Class Reference

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

#include <mlFields.h>

Inheritance diagram for ml::Vector5Field:
ml::Field

List of all members.

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 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 Vector5getVector5Value () const
 Returns the value of the field.
const Vector5getVectorValue () const
 Returns the value of the field.
Deprecated
void setVec5fValue (const Vector5 &value)
const Vector5getVec5fValue () 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 1457 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.


Member Function Documentation

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]
Deprecated:
Use getVector5Value instead.

Definition at line 1517 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 1490 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]
Deprecated:
Use setVector5Value instead.

Definition at line 1514 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 1479 of file mlFields.h.


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