UFString Class Reference

UFString is a UFObject that holds a character string. More...

#include <ufobject.h>

Inheritance diagram for UFString:

[legend]

Collaboration diagram for UFString:

[legend]

List of all members.

Public Member Functions
	UFString (UFName name, const char *defaultValue="")
	Construct a UFString whose initial value is set to its default value.
void	Set (const UFObject &object)
void	Set (const char *string)
	Set the value of the object from the string value.
bool	IsDefault () const
	Return true if object has its default value.
void	SetDefault ()
	Set the current object value to its default value.
void	SetDefault (const char *string)
	Set string as a default value.
void	Reset ()
	Reset the object value to its default value.
bool	IsEqual (const char *string) const
	Return true if object value is equal to string.

---

Detailed Description

UFString is a UFObject that holds a character string.

---

Constructor & Destructor Documentation

UFString::UFString	(	UFName	name,
		const char *	defaultValue = ""
	)			[explicit]

Construct a UFString whose initial value is set to its default value.

---

Member Function Documentation

void UFString::Set

(

const UFObject &

object

)

void UFString::Set

(

const char *

string

)

[virtual]

Set the value of the object from the string value.

This is the reverse of the StringValue() method. If the value changes, an uf_value_changed event is triggered.

Exceptions:

UFException

is thrown if the the string can not be converted to the object type. This could result from a user input error.

Implements UFObject.

bool UFString::IsDefault

(

)

const [virtual]

Return true if object has its default value.

For numerical objects, the values has to the same up to the prescribed accuracy.

Implements UFObject.

void UFString::SetDefault

(

)

[virtual]

Set the current object value to its default value.

A uf_default_changed event is triggered.

Implements UFObject.

void UFString::SetDefault

(

const char *

string

)

Set string as a default value.

A uf_default_changed event is triggered.

void UFString::Reset

(

)

[virtual]

Reset the object value to its default value.

If the value changes, a uf_value_changed event is triggered.

Implements UFObject.

bool UFString::IsEqual

(

const char *

string

)

const

Return true if object value is equal to string.

---

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

• ufobject.h