Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

dtpf::OnOffParameter Class Reference

#include <Parameter.h>

Inheritance diagram for dtpf::OnOffParameter:

dtpf::SpecificParameter dtpf::Parameter dtpf::ParameterTreeVertex List of all members.

Detailed Description

OnOffParameter is a BooleanParameter whose value is either 'on' or 'off'.


Public Member Functions

 OnOffParameter ()
 Construct an OnOffParmeter with the name and default and initial values set to 'off'.
 OnOffParameter (const muscle::String &name, const T &value, const T &default)
 Construct an OnOffParmeter with the given name, and the given default and initial values.
virtual ~OnOffParameter ()
 Destroy an OnOffParameter.
void SetOn ()
 Set the parameter's value to 'on'.
bool IsOn () const
 Find out if the parameter's value is 'on'.
void SetOff ()
 Set the parameter's value to 'off'.
bool IsOff () const
 Find out if the parameter's value is 'off'.
virtual void SetUIType (ParameterUIType uiType)
 Set the UI type to one comaptible with an on/off boolean parameter.

Static Public Attributes

const bool ON = true
 Constant representing the 'on' value.
const bool OFF = false
 Constant representing the 'off' value.


Constructor & Destructor Documentation

dtpf::OnOffParameter::OnOffParameter  )  [inline]
 

Construct an OnOffParmeter with the name and default and initial values set to 'off'.

dtpf::OnOffParameter::OnOffParameter const muscle::String &  name,
const T &  value,
const T &  default
[inline]
 

Construct an OnOffParmeter with the given name, and the given default and initial values.

Parameters:
name The name of the parameter.
value The initial parameter value.
default The default parameter value.

virtual dtpf::OnOffParameter::~OnOffParameter  )  [inline, virtual]
 

Destroy an OnOffParameter.


Member Function Documentation

bool dtpf::OnOffParameter::IsOff  )  const [inline]
 

Find out if the parameter's value is 'off'.

Returns:
true if the parameter is 'off', false otherwise.

bool dtpf::OnOffParameter::IsOn  )  const [inline]
 

Find out if the parameter's value is 'on'.

Returns:
true if the parameter is 'on', false otherwise.

void dtpf::OnOffParameter::SetOff  )  [inline]
 

Set the parameter's value to 'off'.

void dtpf::OnOffParameter::SetOn  )  [inline]
 

Set the parameter's value to 'on'.

virtual void dtpf::OnOffParameter::SetUIType ParameterUIType  uiType  )  [inline, virtual]
 

Set the UI type to one comaptible with an on/off boolean parameter.

Parameters:
uiType The new ParameterUIType.

Implements dtpf::Parameter.


Member Data Documentation

const bool dtpf::OnOffParameter::OFF = false [static]
 

Constant representing the 'off' value.

const bool dtpf::OnOffParameter::ON = true [static]
 

Constant representing the 'on' value.


The documentation for this class was generated from the following file:
Generated on Wed Aug 3 07:26:19 2005 for DTPF by  doxygen 1.3.9.1