ML Reference
ml::IntField Class Reference

Field to encapsulate an integer value. More...

#include <mlFields.h>

Inheritance diagram for ml::IntField:
ml::Field

List of all members.

Public Member Functions

 IntField ()
 Default constructor, do not use it.
 IntField (const std::string &name)
 Constructor, creates a field with a name to manage an integer value.
void setStringValue (const std::string &value)
 Sets value of the field to value.
void setIntValue (MLint intValue)
 Sets field value to intValue.
std::string getStringValue () const
 Returns the value of the field as a string value.
MLint getIntValue () const
 Returns the value of the field as an MLint.
Deprecated
void setIntMaxValue (MLint maxValue)
MLint getIntMaxValue () const
void setIntMinValue (MLint minValue)
MLint getIntMinValue () const
 IntField (const std::string &name, MLintPtr 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 integer value.

Definition at line 149 of file mlFields.h.


Constructor & Destructor Documentation

ml::IntField::IntField ( )

Default constructor, do not use it.

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

Constructor, creates a field with a name to manage an integer value.

Default value is 0.

ml::IntField::IntField ( const std::string &  name,
MLintPtr  valuePtr 
)

Member Function Documentation

MLint ml::IntField::getIntMaxValue ( ) const
Deprecated:
Do not use it.
MLint ml::IntField::getIntMinValue ( ) const
Deprecated:
Do not use it.
MLint ml::IntField::getIntValue ( ) const

Returns the value of the field as an MLint.

std::string ml::IntField::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::IntField::setIntMaxValue ( MLint  maxValue)
Deprecated:
Do not use it.
void ml::IntField::setIntMinValue ( MLint  minValue)
Deprecated:
Do not use it.
void ml::IntField::setIntValue ( MLint  intValue)

Sets field value to intValue.

void ml::IntField::setStringValue ( const std::string &  value) [virtual]

Sets value of the field to value.

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.


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