ml::DoubleField Class Reference
Field to encapsulate a double value. More...
#include <mlFields.h>
Inheritance diagram for ml::DoubleField:
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. | |
| 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. | |
Detailed Description
Field to encapsulate a double value.
Definition at line 639 of file mlFields.h.
Constructor & Destructor Documentation
| 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 | ||
| ) |
- Deprecated:
- Use DoubleField(const std::string& name) instead.
Member Function Documentation
| double ml::DoubleField::getDoubleMaxValue | ( | ) | const |
- Deprecated:
- Do not use it.
| double ml::DoubleField::getDoubleMinValue | ( | ) | const |
- Deprecated:
- Do not use it.
| 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 | ) |
- Deprecated:
- Do not use it.
| void ml::DoubleField::setDoubleMinValue | ( | double | minValue | ) |
- Deprecated:
- Do not use it.
| 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] |
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlFields.h
