dtpf::SpecificParameter Class Reference

#include <Parameter.h>

Inheritance diagram for dtpf::SpecificParameter:

List of all members.

---

Detailed Description

SpecificParameter extends Parameter to managing a value of templated type.

This inheritance relationship allows Parameters to be treated polymorphically for some operations since there is a single common superclass, while SpecificParameters can be treated generically using templated types.

Public Member Functions
virtual	~SpecificParameter ()
	Destroy a SpecificParameter.
virtual void	SetValue (const T &value)
	Set a parameter's value.
virtual T	GetValue () const
	Get a parameter's value.
virtual void	SetDefault (const T &default)
	Set a parameter's default value.
virtual T	GetDefault () const
	Get a parameter's default value.
Protected Member Functions
	SpecificParameter (const muscle::String &name, ParamType paramType, ParamUIType uiType, const T &value, const T &default)
	Construct a specific parameter with the given name, parameter type, UI type, and initial and default values.
Protected Attributes
T	m_value
	The current parameter value.
T	m_default
	The default parameter value.

---

Constructor & Destructor Documentation

virtual dtpf::SpecificParameter::~SpecificParameter (   )  [inline, virtual]

Destroy a SpecificParameter.

dtpf::SpecificParameter::SpecificParameter (  const muscle::String &  name, ParamType  paramType, ParamUIType  uiType, const T &  value, const T &  default )  [inline, protected]

Construct a specific parameter with the given name, parameter type, UI type, and initial and default values. Parameters: name  The name of the parameter. paramType  The type of parameter. uiType  The preferred UI type. value  The initial value. default  The default value.

---

Member Function Documentation

virtual T dtpf::SpecificParameter::GetDefault (   )  const [inline, virtual]

Get a parameter's default value. Returns: The current default value.

virtual T dtpf::SpecificParameter::GetValue (   )  const [inline, virtual]

Get a parameter's value. Returns: The current value.

virtual void dtpf::SpecificParameter::SetDefault (  const T &  default  )  [inline, virtual]

Set a parameter's default value. Parameters: default  The new default value.

virtual void dtpf::SpecificParameter::SetValue (  const T &  value  )  [inline, virtual]

Set a parameter's value. Parameters: value  The new value. Reimplemented in dtpf::GroupParameter, dtpf::RangeParameter, dtpf::FileParameter, and dtpf::TextParameter.

---

Member Data Documentation

T dtpf::SpecificParameter::m_default [protected]

The default parameter value.

T dtpf::SpecificParameter::m_value [protected]

The current parameter value.

---

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

• Lib/Parameter.h

---