ML Reference
Public Member Functions | Protected Member Functions
ml::SubImageBoxdField Class Reference
Fields

Field to encapsulate an ML double SubimgBox. More...

#include <mlFields.h>

Inheritance diagram for ml::SubImageBoxdField:
ml::Field

List of all members.

Public Member Functions

 SubImageBoxdField ()
 Default constructor, do not use it.
 SubImageBoxdField (const std::string &name)
 Constructor, creates a field with a name to manage a float box.
void setStringValue (const std::string &stringValue)
 Sets the value of the field to stringValue.
void setSubImageBoxdValue (const SubImageBoxd &subImageBoxfValue)
 Sets the value of the field to subImageBoxfValue.
void updateSubImageBoxdValue (const SubImageBoxd &subImageBoxfValue)
 Sets the value of the field to subImageBoxfValue, 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.
const SubImageBoxd & getSubImageBoxdValue () const
 Returns the value of the field.
Deprecated
void setSubImgBoxValue (const SubImageBoxd &value)
const SubImageBoxd & getSubImgBoxValue () const
void setSubImgBoxfValue (const SubImageBoxd &value)
const SubImageBoxd & getSubImgBoxfValue () const
 SubImageBoxdField (const std::string &name, SubImageBoxd *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 double SubimgBox.

Definition at line 2550 of file mlFields.h.

Constructor & Destructor Documentation

ml::SubImageBoxdField::SubImageBoxdField ( )

Default constructor, do not use it.

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

Constructor, creates a field with a name to manage a float box.

Default value is the empty box.

ml::SubImageBoxdField::SubImageBoxdField ( const std::string &  name,
SubImageBoxd *  valuePtr 
)
Deprecated:
Use SubImageBoxdField(const std::string& name) instead.

Member Function Documentation

std::string ml::SubImageBoxdField::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 SubImageBoxd& ml::SubImageBoxdField::getSubImageBoxdValue ( ) const

Returns the value of the field.

const SubImageBoxd& ml::SubImageBoxdField::getSubImgBoxfValue ( ) const [inline]
Deprecated:
Use getSubImageBoxdValue instead.

Definition at line 2615 of file mlFields.h.

const SubImageBoxd& ml::SubImageBoxdField::getSubImgBoxValue ( ) const [inline]
Deprecated:
Use getSubImageBoxdValue instead.

Definition at line 2609 of file mlFields.h.

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

Sets the value of the field to stringValue.

Implements ml::Field.

void ml::SubImageBoxdField::setSubImageBoxdValue ( const SubImageBoxd &  subImageBoxfValue)

Sets the value of the field to subImageBoxfValue.

void ml::SubImageBoxdField::setSubImgBoxfValue ( const SubImageBoxd &  value) [inline]
Deprecated:
Use setSubImageBoxdValue instead.

Definition at line 2612 of file mlFields.h.

void ml::SubImageBoxdField::setSubImgBoxValue ( const SubImageBoxd &  value) [inline]
Deprecated:
Use setSubImageBoxdValue instead.

Definition at line 2606 of file mlFields.h.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::SubImageBoxdField::updateSubImageBoxdValue ( const SubImageBoxd &  subImageBoxfValue)

Sets the value of the field to subImageBoxfValue, 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: