ML Reference
ml::MLDataTypeField Class Reference

Field to encapsulate an MLDataType value. More...

#include <mlFields.h>

Inheritance diagram for ml::MLDataTypeField:
ml::Field

List of all members.

Public Member Functions

 MLDataTypeField ()
 Default constructor, do not use it.
 MLDataTypeField (const std::string &name)
 Constructor, creates a field with a name to manage an MLDataType value.
void setStringValue (const std::string &stringValue)
 Sets the value of the field to stringValue. Invalid types set the type to MLint8Type.
void setMLDataTypeValue (MLDataType dataType)
 Sets the field value to data type dataType.
std::string getStringValue () const
 Returns the value of the field as a string value.
MLDataType getMLDataTypeValue () const
 Returns the value of the field.
Deprecated
 MLDataTypeField (const std::string &name, MLDataType *valuePtr)

Detailed Description

Field to encapsulate an MLDataType value.

Definition at line 2211 of file mlFields.h.


Constructor & Destructor Documentation

ml::MLDataTypeField::MLDataTypeField ( )

Default constructor, do not use it.

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

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

Default value is MLuint8Type.

ml::MLDataTypeField::MLDataTypeField ( const std::string &  name,
MLDataType valuePtr 
)

Member Function Documentation

MLDataType ml::MLDataTypeField::getMLDataTypeValue ( ) const

Returns the value of the field.

std::string ml::MLDataTypeField::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::MLDataTypeField::setMLDataTypeValue ( MLDataType  dataType)

Sets the field value to data type dataType.

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

Sets the value of the field to stringValue. Invalid types set the type to MLint8Type.

Implements ml::Field.


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