CParamTable Class Reference

CParamTable. More...

#include <ParamTable.h>

List of all members.

Static Public Member Functions

static void RegisterParameter (PARAMETER, CParamable *, bool bReadOnly=false)

RegisterParameter.

static int32 getParam (PARAMETER, int32 iWhich=0)

getParam

static bool setParam (PARAMETER, int32 iValue, int32 iWhich=0)

setParam

Detailed Description

CParamTable.

Description: The parameter table class provides a convient way to manage system parameters. This class provides a mechanism for binding parameter numbers to a particular classes get and set accessor functions.

Limitations: None

Member Function Documentation

int32 CParamTable::getParam ( PARAMETER param,

int32 iWhich = 0

) [static]

getParam
Description: The getParam fucntion is used to retrive the value of a specified parameter.

Parameters:

param - The parameter whose value is to be returned.

iWhich - Not currently use.

Returns:
int: The value of the parameter is returned. If the parameter has not been bound to any particular varaible or accessor functions, zero is returned.
Limitations: None

void CParamTable::RegisterParameter ( PARAMETER param,

CParamable * p,

bool bReadOnly = false

) [static]

RegisterParameter.
Description: This function is used to bind a system parameter to a CParamable derived class's member accessor function pair.

Parameters:

param - The parameter to be bound.

g - A function pointer to the "get" function that will be called to retrieve the value of the parameter. This function parameter can be set to NULL to indicate that the sytem param is write-only.

s - A function pointer to the "set" function that will be called to set the value of the parameter. This function parameter can be set to NULL to indicate that the sytem param is read-only.

Returns:
void
Limitations: Only one class instance can be bound with a parameter at any given time. As a general rule, only bind parameters to memebers of singleton classes.

bool CParamTable::setParam ( PARAMETER param,

int32 iValue,

int32 iWhich = 0

) [static]

setParam
Description: This function is used to set the value of a specified parameter.

Parameters:

param - The parameter whose value is to be set.

iValue - The value to be associated with the parameter.

iWhich - Not currently used; Should be set to zero.

Returns:
bool: True if the parameter value was set. If the parameter had not yet been bound or parameter was registered as read-only, setParam will fail and return false.
Limitations: None

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

Common/ParamTable.h
Common/ParamTable.cpp


Static Public Member Functions
static void	RegisterParameter (PARAMETER, CParamable *, bool bReadOnly=false)
	RegisterParameter.
static int32	getParam (PARAMETER, int32 iWhich=0)
	getParam
static bool	setParam (PARAMETER, int32 iValue, int32 iWhich=0)
	setParam