Parameter Class Reference

#include <Parameter.h>

Inheritance diagram for Parameter:

List of all members.

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)
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

---

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