Field to encapsulate a string value. More...

#include <mlFields.h>

Inheritance diagram for ml::StringField:

Public Member Functions
	StringField ()
	Default constructor, do not use it.
	StringField (const std::string &name)
	Constructor, creates a field with a `name` to manage a string value.
void	setStringValue (const std::string &stringValue)
	Sets value of the field to `stringValue`.
void	updateStringValue (const std::string &stringValue)
	Sets value of the field to `stringValue`, 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 setStringValue must be able to reinterpret this returned string correctly.

Detailed Description

Field to encapsulate a string value.

Definition at line 834 of file mlFields.h.

Constructor & Destructor Documentation

ml::StringField::StringField ( )

Default constructor, do not use it.

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

Constructor, creates a field with a name to manage a string value.

std::string ml::StringField::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::StringField::setStringValue ( const std::string & stringValue ) [virtual]

Sets value of the field to stringValue.

Implements ml::Field.

void ml::StringField::updateStringValue ( const std::string & stringValue )

Sets value of the field to stringValue, but only touch field if the new value is different from the old value.

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