deModuleParameter Class Reference

Module Parameter Class. More...

#include <deModuleParameter.h>

List of all members.

Public Types
enum	eParameterTypes { eptBoolean, eptNumeric, eptRanged, eptSelection }
Public Member Functions
Constructors and Destructors
	deModuleParameter ()
	Creates a new module parameter.
	~deModuleParameter ()
	Cleans up the module parameter.
Management
int	GetType () const
	Retrieves the type of the parameter.
void	SetType (int type)
	Sets the type of the parameter.
const char *	GetName () const
	Retrieves the name.
void	SetName (const char *name)
	Sets the name.
const char *	GetDescription () const
	Retrieves the description.
void	SetDescription (const char *description)
	Sets the description.
float	GetMinimumValue () const
	Retrieves the minimum value.
void	SetMinimumValue (float minValue)
	Sets the minimum value.
float	GetMaximumValue () const
	Retrieves the maximum value.
void	SetMaximumValue (float maxValue)
	Sets the maximum value.
float	GetValueStepSize () const
	Retrieves the value step size.
void	SetValueStepSize (float valueStepSize)
	Sets the value step size.
void	Reset ()
	Resets the parameter to default values.
Selection Management
int	GetSelectionEntryCount () const
	Retrieves the number of selection entries.
const char *	GetSelectionEntryAt (int index) const
	Retrieves the selection entry at the given index.
void	AddSelectionEntry (const char *selectionEntry)
	Adds a selection entry.
void	RemoveAllSelectionEntries ()
	Removes all selection entries.

---

Detailed Description

Module Parameter Class.

Contains informations about a module parameter. This informations is designed to help scripters to generate GUI widgets for the parameters matching the type of the parameter to make it easier for the user to set the correct values. The parameter can be of one of the four types boolean, numeric, ranged and selection. A boolean parameter accepts values 0 for false and 1 for true. The numeric parameter accepts all kinds of decimal values. The Ranged parameter accepts only values in a given range spaced by a given step size. The range is mandatory but the step size is optional to be cared about by the parameter user. The selection parameter provides a list of values. The index into this list is the value returned.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Member Enumeration Documentation

enum deModuleParameter::eParameterTypes

Enumerator:

eptBoolean	Boolean value.
eptNumeric	Numeric value.
eptRanged	Ranged value which has to be inside a given range.
eptSelection	Value from a selection of values.

---

Constructor & Destructor Documentation

deModuleParameter::deModuleParameter

(

)

Creates a new module parameter.

deModuleParameter::~deModuleParameter

(

)

Cleans up the module parameter.

---

Member Function Documentation

void deModuleParameter::AddSelectionEntry

(

const char *

selectionEntry )

Adds a selection entry.

const char* deModuleParameter::GetDescription

(

)

const [inline]

Retrieves the description.

float deModuleParameter::GetMaximumValue

(

)

const [inline]

Retrieves the maximum value.

float deModuleParameter::GetMinimumValue

(

)

const [inline]

Retrieves the minimum value.

const char* deModuleParameter::GetName

(

)

const [inline]

Retrieves the name.

const char* deModuleParameter::GetSelectionEntryAt

(

int

index )

const

Retrieves the selection entry at the given index.

int deModuleParameter::GetSelectionEntryCount

(

)

const [inline]

Retrieves the number of selection entries.

int deModuleParameter::GetType

(

)

const [inline]

Retrieves the type of the parameter.

float deModuleParameter::GetValueStepSize

(

)

const [inline]

Retrieves the value step size.

void deModuleParameter::RemoveAllSelectionEntries

(

)

Removes all selection entries.

void deModuleParameter::Reset

(

)

Resets the parameter to default values.

void deModuleParameter::SetDescription

(

const char *

description )

Sets the description.

void deModuleParameter::SetMaximumValue

(

float

maxValue )

Sets the maximum value.

void deModuleParameter::SetMinimumValue

(

float

minValue )

Sets the minimum value.

void deModuleParameter::SetName

(

const char *

name )

Sets the name.

void deModuleParameter::SetType

(

int

type )

Sets the type of the parameter.

void deModuleParameter::SetValueStepSize

(

float

valueStepSize )

Sets the value step size.

---

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

• deModuleParameter.h