#include <Parameter.h>

Inheritance diagram for Parameter:

Public Member Functions
	Parameter (const string &name, const string &description, double value, int type, int key)

	Parameter (const string &name, const string &description, bool *value, int key)

	Parameter (const string &name, const string &description, int *value, int key)

	Parameter (const string &name, const string &description, float *value, int key)

	Parameter (const string &name, const string &description, double *value, int key)

	Parameter (const Parameter &parameter)

const Parameter &	operator= (const Parameter &parameter)

int	getKey () const

int	getType () const

bool	getBoolValue () const

int	getIntValue () const

float	getFloatValue () const

double	getDoubleValue () const

void	setKey (int key)

void	setValue (bool value)

void	setValue (int value)

void	setValue (float value)

void	setValue (double value)

void	set (const string &name, const string &description, double value, int type=Double, int key=0)

void	set (const string &name, const string &description, bool *value, int key=0)

void	set (const string &name, const string &description, int *value, int key=0)

void	set (const string &name, const string &description, float *value, int key=0)

void	set (const string &name, const string &description, double *value, int key=0)

Public Member Functions inherited from Named
void	setName (const string &newName)
	Set the name of the object.

const string &	getName () const
	Get the name of the object.

bool	isName (const string &aName) const
	Determine whether name equals given name.

Public Member Functions inherited from Described
void	setDescription (const string &description)
	Set the Describe of the object.

const string	getDescription () const
	Get the Describe of the object.

bool	isDescribed () const
	Determine whether Describe is set, i.e object has a Describe.

bool	isDescription (const string &description) const
	Determine whether Describe equals given Describe.

bool	sameDescriptionAs (const Described &described) const
	Determine whether Describe equals that of given object.

Static Public Attributes
static const int	Boolean = 0

static const int	Integer = 1

static const int	Float = 2

static const int	Double = 3

Protected Attributes
int	_key

int	_type

double	_value

void *	_exValue

Protected Attributes inherited from Named
string	_name

Protected Attributes inherited from Described
string	_description

Additional Inherited Members
Protected Member Functions inherited from Named
	Named (const string &aName=" ")
	Only derived class are Named.

Protected Member Functions inherited from Described
	Described (const string &aDescribe=" ")
	Only derived class are Described.

Detailed Description

Class defining a mutable and generic parameter.

A parameter has a value, a name, and can also be given a short description. The parameter may be of type Boolean, Integer, or Double. An integer key may be optionally specified to provide a unique identifier. This class is a base class for ConstrainedParameter and EditableParameter classes.

See Also: ConstrainedParameter; EditableParameter

Definition at line 23 of file Parameter.h.

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

Sti/Base/Parameter.h
Sti/Base/Parameter.cxx

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description