Parameter.h File Reference

Namespaces
namespace	dtpf
Classes
class	dtpf::Parameter
	Represents a value and the bounds of that parameter. More...
class	dtpf::SpecificParameter
	SpecificParameter extends Parameter to managing a value of templated type. More...
class	dtpf::OnOffParameter
	OnOffParameter is a BooleanParameter whose value is either 'on' or 'off'. More...
class	dtpf::GroupParameter
	GroupParameter is a SpecificParameter whose value can be is a selection from a group of items. More...
class	dtpf::RangeParameter
	RangeParameter is a SpecificParameter for numeric parameters with a value between minimum and maximum bounds with a increment step. More...
class	dtpf::FileParameter
	FileParameter is a SpecificParameter with values identifying objects on the filesystem (e.g., files, directories, etc). More...
class	dtpf::TextParameter
	TextParameter is a StringParameter with values that can be single or multiple line text strings. More...
Typedefs
typedef SpecificParameter< bool >	BooleanParameter
	A typdef for boolean valued parameters.
typedef SpecificParameter< int64 >	IntegerParameter
	A typedef for long integer valued parameters.
typedef SpecificParameter< double >	FloatimgPointParameter
	A typdef for double valued parameters.
typedef SpecificParameter< muscle::String >	StringParameter
	A typdef for string valued parameters.
Enumerations
enum	ParameterType {   PARAM_ON_OFF = 0,   PARAM_GROUP = 1,   PARAM_RANGE = 2,   PARAM_FILE = 4,   PARAM_TEXT = 8 }
	An enumeration of parameter kinds. More...
enum	ParameterUIType {   PARAM_CHECK_UI = 0,   PARAM_RADIO_UI,   PARAM_LIST_UI,   PARAM_COMBO_UI,   PARAM_SLIDER_UI,   PARAM_SPINNER_UI,   PARAM_FILE_UI,   PARAM_TEXT_LINE_UI,   PARAM_TEXT_BOX_UI }
	An enumeration of preferred parameter user interface types. More...

---

Typedef Documentation

typedef SpecificParameter<bool> dtpf::BooleanParameter

A typdef for boolean valued parameters.

typedef SpecificParameter<double> dtpf::FloatimgPointParameter

A typdef for double valued parameters.

typedef SpecificParameter<int64> dtpf::IntegerParameter

A typedef for long integer valued parameters.

typedef SpecificParameter<muscle::String> dtpf::StringParameter

A typdef for string valued parameters.

---

Enumeration Type Documentation

enum ParameterType

An enumeration of parameter kinds. Enumeration values: PARAM_ON_OFF  An on or off parameter. PARAM_GROUP  A parameter whose value can be a selection from a group. PARAM_RANGE  A numeric parameter whose value is bounded by minimum and maximum values. PARAM_FILE  A file path parameter. PARAM_TEXT  A text parameter.

enum ParameterUIType

An enumeration of preferred parameter user interface types. Enumeration values: PARAM_CHECK_UI  Preferred UI is a checkbox, for PARAM_ON_OFF. PARAM_RADIO_UI  Preferred UI is a set of radio buttons, for PARAM_EXCLUSIVE. PARAM_LIST_UI  Preferred UI is a list of items, for PARAM_GROUP and PARAM_EXCLUSIVE. PARAM_COMBO_UI  Preferred UI is a combobox (drop-down menu), for PARAM_GROUP and PARAM_EXCLUSIVE. PARAM_SLIDER_UI  Preferred UI is a slider control, for PARAM_RANGE. PARAM_SPINNER_UI  Preferred UI is a spinner control (a text field for value entry and display, and two buttons to increase or decrease the value), for PARAM_RANGE. PARAM_FILE_UI  Preferred UI is a file chooser, for PARAM_FILE. PARAM_TEXT_LINE_UI  Preferred UI is a single line text field, for PARAM_TEXT. PARAM_TEXT_BOX_UI  Preferred UI is a multiple line text box, for PARAM_TEXT.

---