tunableFloatConstant Class Reference

#include <tunableConst.h>

Inheritance diagram for tunableFloatConstant:

Public Member Functions
	tunableFloatConstant (float initialValue, float min, float max, floatChangeValCallBackFunc cb, tunableUse type, const char *name, const char *desc)
	tunableFloatConstant (float initialValue, isValidFunc, floatChangeValCallBackFunc cb, tunableUse type, const char *name, const char *desc)
float	getValue ()
bool	setValue (float newVal)
float	getMin ()
float	getMax ()
virtual void	print ()
const char *	getDesc () const
const char *	getName () const
tunableUse	getUse () const
tunableType	getType () const
Static Public Member Functions
static tunableConstant *	findTunableConstant (const char *name)
static List< tunableConstant * >	beginIteration ()
static int	numTunables ()
Protected Attributes
char *	desc
char *	name
tunableType	typeName
tunableUse	use
Static Protected Attributes
static stringPool *	pool
static List< tunableConstant * > *	allConstants
Private Member Functions
bool	simpleRangeCheck (float val)
Private Attributes
float	value
float	min
float	max
isValidFunc	isValidValue
floatChangeValCallBackFunc	newValueCallBack

---

Detailed Description

Definition at line 168 of file tunableConst.h.

---

Constructor & Destructor Documentation

tunableFloatConstant::tunableFloatConstant	(	float	initialValue,
		float	min,
		float	max,
		floatChangeValCallBackFunc	cb,
		tunableUse	type,
		const char *	name,
		const char *	desc
	)

tunableFloatConstant::tunableFloatConstant	(	float	initialValue,
		isValidFunc	,
		floatChangeValCallBackFunc	cb,
		tunableUse	type,
		const char *	name,
		const char *	desc
	)

---

Member Function Documentation

static List<tunableConstant *> tunableConstant::beginIteration

(

)

[inline, static, inherited]

Definition at line 119 of file tunableConst.h.

References tunableConstant::allConstants.

static tunableConstant* tunableConstant::findTunableConstant

(

const char *

name

)

[static, inherited]

const char* tunableConstant::getDesc

(

)

const [inline, inherited]

Definition at line 103 of file tunableConst.h.

References tunableConstant::desc.

float tunableFloatConstant::getMax

(

)

[inline]

Definition at line 211 of file tunableConst.h.

References max.

float tunableFloatConstant::getMin

(

)

[inline]

Definition at line 210 of file tunableConst.h.

References min.

const char* tunableConstant::getName

(

)

const [inline, inherited]

Definition at line 106 of file tunableConst.h.

References tunableConstant::name.

tunableType tunableConstant::getType

(

)

const [inline, inherited]

Definition at line 112 of file tunableConst.h.

References tunableConstant::typeName.

tunableUse tunableConstant::getUse

(

)

const [inline, inherited]

Definition at line 109 of file tunableConst.h.

References tunableConstant::use.

float tunableFloatConstant::getValue

(

)

[inline]

Definition at line 192 of file tunableConst.h.

References value.

static int tunableConstant::numTunables

(

)

[inline, static, inherited]

Definition at line 130 of file tunableConst.h.

References tunableConstant::allConstants, and ListBase< DataType, KeyType >::count().

virtual void tunableFloatConstant::print

(

)

[virtual]

Reimplemented from tunableConstant.

bool tunableFloatConstant::setValue

(

float

newVal

)

[inline]

Definition at line 193 of file tunableConst.h.

References isValidValue, newValueCallBack, simpleRangeCheck(), and value.

bool tunableFloatConstant::simpleRangeCheck

(

float

val

)

[private]

Referenced by setValue().

---

Field Documentation

List<tunableConstant*>* tunableConstant::allConstants [static, protected, inherited]

Definition at line 97 of file tunableConst.h.

Referenced by tunableConstant::beginIteration(), and tunableConstant::numTunables().

char* tunableConstant::desc [protected, inherited]

Definition at line 90 of file tunableConst.h.

Referenced by tunableConstant::getDesc().

isValidFunc tunableFloatConstant::isValidValue [private]

Definition at line 172 of file tunableConst.h.

Referenced by setValue().

float tunableFloatConstant::max [private]

Definition at line 171 of file tunableConst.h.

Referenced by getMax().

float tunableFloatConstant::min [private]

Definition at line 171 of file tunableConst.h.

Referenced by getMin().

char* tunableConstant::name [protected, inherited]

Definition at line 91 of file tunableConst.h.

Referenced by tunableConstant::getName().

floatChangeValCallBackFunc tunableFloatConstant::newValueCallBack [private]

Definition at line 174 of file tunableConst.h.

Referenced by setValue().

stringPool* tunableConstant::pool [static, protected, inherited]

Definition at line 95 of file tunableConst.h.

tunableType tunableConstant::typeName [protected, inherited]

Definition at line 92 of file tunableConst.h.

Referenced by tunableConstant::getType().

tunableUse tunableConstant::use [protected, inherited]

Definition at line 93 of file tunableConst.h.

Referenced by tunableConstant::getUse().

float tunableFloatConstant::value [private]

Definition at line 170 of file tunableConst.h.

Referenced by getValue(), and setValue().

---

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

• common/h/tunableConst.h