ML Reference
|
Field to encapsulate a double value. More...
#include <mlFields.h>
Public Member Functions | |
DoubleField () | |
Default constructor, do not use it. | |
DoubleField (const std::string &name) | |
Constructor, creates a field with a name to manage a double value. | |
void | setStringValue (const std::string &stringValue) |
Sets value of the field to stringValue . | |
void | setDoubleValue (double doubleValue) |
Set field value to doubleValue . By default the entire double type range can be set. | |
void | updateDoubleValue (double doubleValue) |
Set field value to doubleValue , 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 setStringValue must be able to reinterpret this returned string correctly. | |
double | getDoubleValue () const |
Returns current field value. | |
Deprecated | |
void | setDoubleMaxValue (double maxValue) |
double | getDoubleMaxValue () const |
void | setDoubleMinValue (double minValue) |
double | getDoubleMinValue () const |
DoubleField (const std::string &name, double *valuePtr) | |
Protected Member Functions | |
virtual void | setValueFromField (const Field &field) |
Reimplementation from Field which copies the field value more efficiently. |
Field to encapsulate a double value.
Definition at line 657 of file mlFields.h.
ml::DoubleField::DoubleField | ( | ) |
Default constructor, do not use it.
ml::DoubleField::DoubleField | ( | const std::string & | name | ) |
Constructor, creates a field with a name
to manage a double value.
Default value is 0.
ml::DoubleField::DoubleField | ( | const std::string & | name, |
double * | valuePtr | ||
) |
double ml::DoubleField::getDoubleMaxValue | ( | ) | const |
double ml::DoubleField::getDoubleMinValue | ( | ) | const |
double ml::DoubleField::getDoubleValue | ( | ) | const |
Returns current field value.
std::string ml::DoubleField::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::DoubleField::setDoubleMaxValue | ( | double | maxValue | ) |
void ml::DoubleField::setDoubleMinValue | ( | double | minValue | ) |
void ml::DoubleField::setDoubleValue | ( | double | doubleValue | ) |
Set field value to doubleValue
. By default the entire double type range can be set.
void ml::DoubleField::setStringValue | ( | const std::string & | stringValue | ) | [virtual] |
Sets value of the field to stringValue
.
Implements ml::Field.
virtual void ml::DoubleField::setValueFromField | ( | const Field & | field | ) | [protected, virtual] |
void ml::DoubleField::updateDoubleValue | ( | double | doubleValue | ) |
Set field value to doubleValue
, 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!) By default the entire double type range can be set.