ml::SubImageBoxField Class Reference
[Fields]
Field to encapsulate an ML integer SubimgBox.
More...
#include <mlFields.h>
Inheritance diagram for ml::SubImageBoxField:
Public Member Functions | |
| SubImageBoxField () | |
| Default constructor, do not use it. | |
| SubImageBoxField (const std::string &name) | |
Constructor, creates a field with a name to manage an integer box. | |
| void | setStringValue (const std::string &stringValue) |
Sets the value of the field to stringValue. | |
| void | setSubImageBoxValue (const SubImageBox &subImageBoxValue) |
Sets the value of the field to subImageBoxValue. | |
| std::string | getStringValue () const |
| Returns the value of the field as a string value. | |
| const SubImageBox & | getSubImageBoxValue () const |
| Returns the value of the field. | |
Deprecated | |
| void | setSubImgBoxValue (const SubImageBox &value) |
| const SubImageBox & | getSubImgBoxValue () const |
Deprecated | |
| SubImageBoxField (const std::string &name, SubImageBox *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 an ML integer SubimgBox.Definition at line 2360 of file mlFields.h.
Constructor & Destructor Documentation
| ml::SubImageBoxField::SubImageBoxField | ( | ) |
Default constructor, do not use it.
| ml::SubImageBoxField::SubImageBoxField | ( | const std::string & | name | ) |
Constructor, creates a field with a name to manage an integer box.
Default value is an empty box.
| ml::SubImageBoxField::SubImageBoxField | ( | const std::string & | name, | |
| SubImageBox * | valuePtr | |||
| ) |
- Deprecated:
- Use SubImageBoxField(const std::string& name) instead.
Member Function Documentation
| std::string ml::SubImageBoxField::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 SubImageBox& ml::SubImageBoxField::getSubImageBoxValue | ( | ) | const |
Returns the value of the field.
| const SubImageBox& ml::SubImageBoxField::getSubImgBoxValue | ( | ) | const [inline] |
| void ml::SubImageBoxField::setStringValue | ( | const std::string & | stringValue | ) | [virtual] |
| void ml::SubImageBoxField::setSubImageBoxValue | ( | const SubImageBox & | subImageBoxValue | ) |
Sets the value of the field to subImageBoxValue.
| void ml::SubImageBoxField::setSubImgBoxValue | ( | const SubImageBox & | value | ) | [inline] |
| virtual void ml::SubImageBoxField::setValueFromField | ( | const Field & | field | ) | [protected, virtual] |
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlFields.h
