cmlabs::Parameter Class Reference

Parameters can hold a value and you can get, set, increment, decrement. More...

#include <Parameter.h>

Inheritance diagram for cmlabs::Parameter:

[legend]

Collaboration diagram for cmlabs::Parameter:

[legend]

List of all members.

Public Member Functions
	Parameter (const JString &parametername, const JString &type)
	Parameter (const JString &xml)
	Parameter (XMLNode *node)
	Parameter (const JString &parametername, const JString &type, const Collection &collValues)
	Parameter (const JString &parametername, const JString &type, const JString &val, const JString &defaultVal="")
virtual	~Parameter ()
Object *	clone () const
virtual unsigned long	getPayloadSize () const
	Get total size of payload.
bool	unitTest ()
bool	fromXML (const JString &xml)
bool	fromXML (XMLNode *node)
JString	toXML ()
JString	print ()
bool	reset ()
bool	increment (int steps)
bool	decrement (int steps)
JString	getName ()
bool	setType (const JString &type)
JString	getType ()
int	getInteger ()
double	getDouble ()
JString	getString ()
void *	getPointer ()
JString	getAsString ()
bool	set (const JString &val)
bool	setString (const JString &val)
bool	setInteger (int val)
bool	setDouble (double val)
bool	setPointer (void *val)
bool	setMinMax (double min, double max)
bool	addItem (const JString &value)
bool	removeItem (const JString &value)
Static Public Member Functions
static ObjectDictionary *	getParameterCollectionFromNode (XMLNode *node)
static JString	getParameterValueFromCollection (ObjectDictionary *parameters, const JString &name)
Public Attributes
JString	name
JString	value
JString	defaultValue
JString	valueType
JString	parameterType
JString	notify
double	step
bool	locked
double	minValue
double	maxValue
Collection	values
Protected Attributes
int	current
int	def

---

Detailed Description

Parameters can hold a value and you can get, set, increment, decrement.

Definition at line 45 of file Parameter.h.

---

Constructor & Destructor Documentation

cmlabs::Parameter::Parameter	(	const JString &	parametername,
		const JString &	type
	)

Definition at line 73 of file Parameter.cpp.

cmlabs::Parameter::Parameter

(

const JString &

xml

)

Definition at line 80 of file Parameter.cpp.

cmlabs::Parameter::Parameter

(

XMLNode *

node

)

Definition at line 88 of file Parameter.cpp.

cmlabs::Parameter::Parameter	(	const JString &	parametername,
		const JString &	type,
		const Collection &	collValues
	)

Definition at line 33 of file Parameter.cpp.

cmlabs::Parameter::Parameter	(	const JString &	parametername,
		const JString &	type,
		const JString &	val,
		const JString &	defaultVal = ""
	)

Definition at line 43 of file Parameter.cpp.

cmlabs::Parameter::~Parameter

(

)

[virtual]

Definition at line 106 of file Parameter.cpp.

---

Member Function Documentation

ObjectDictionary * cmlabs::Parameter::getParameterCollectionFromNode

(

XMLNode *

node

)

[static]

Definition at line 508 of file Parameter.cpp.

JString cmlabs::Parameter::getParameterValueFromCollection	(	ObjectDictionary *	parameters,
		const JString &	name
	)			[static]

Definition at line 499 of file Parameter.cpp.

Object * cmlabs::Parameter::clone

(

)

const [virtual]

Implements cmlabs::Object.

Definition at line 99 of file Parameter.cpp.

unsigned long cmlabs::Parameter::getPayloadSize

(

)

const [virtual]

Get total size of payload.

Reimplemented from cmlabs::Object.

Definition at line 111 of file Parameter.cpp.

bool cmlabs::Parameter::unitTest

(

)

[virtual]

Reimplemented from cmlabs::Object.

Definition at line 555 of file Parameter.cpp.

bool cmlabs::Parameter::fromXML

(

const JString &

xml

)

[virtual]

Reimplemented from cmlabs::Object.

Definition at line 163 of file Parameter.cpp.

bool cmlabs::Parameter::fromXML

(

XMLNode *

node

)

[virtual]

Reimplemented from cmlabs::Object.

Definition at line 175 of file Parameter.cpp.

JString cmlabs::Parameter::toXML

(

)

[virtual]

Reimplemented from cmlabs::Object.

Definition at line 140 of file Parameter.cpp.

JString cmlabs::Parameter::print

(

)

[virtual]

Reimplemented from cmlabs::Object.

Definition at line 116 of file Parameter.cpp.

bool cmlabs::Parameter::reset

(

)

Definition at line 451 of file Parameter.cpp.

bool cmlabs::Parameter::increment

(

int

steps

)

Definition at line 457 of file Parameter.cpp.

bool cmlabs::Parameter::decrement

(

int

steps

)

Definition at line 478 of file Parameter.cpp.

JString cmlabs::Parameter::getName

(

)

Definition at line 361 of file Parameter.cpp.

bool cmlabs::Parameter::setType

(

const JString &

type

)

Definition at line 240 of file Parameter.cpp.

JString cmlabs::Parameter::getType

(

)

Definition at line 357 of file Parameter.cpp.

int cmlabs::Parameter::getInteger

(

)

Definition at line 365 of file Parameter.cpp.

double cmlabs::Parameter::getDouble

(

)

Definition at line 379 of file Parameter.cpp.

JString cmlabs::Parameter::getString

(

)

Definition at line 393 of file Parameter.cpp.

void * cmlabs::Parameter::getPointer

(

)

Definition at line 416 of file Parameter.cpp.

JString cmlabs::Parameter::getAsString

(

)

Definition at line 406 of file Parameter.cpp.

bool cmlabs::Parameter::set

(

const JString &

val

)

Definition at line 216 of file Parameter.cpp.

bool cmlabs::Parameter::setString

(

const JString &

val

)

Definition at line 257 of file Parameter.cpp.

bool cmlabs::Parameter::setInteger

(

int

val

)

Definition at line 281 of file Parameter.cpp.

bool cmlabs::Parameter::setDouble

(

double

val

)

Definition at line 309 of file Parameter.cpp.

bool cmlabs::Parameter::setPointer

(

void *

val

)

Definition at line 335 of file Parameter.cpp.

bool cmlabs::Parameter::setMinMax	(	double	min,
		double	max
	)

Definition at line 245 of file Parameter.cpp.

bool cmlabs::Parameter::addItem

(

const JString &

value

)

Definition at line 425 of file Parameter.cpp.

bool cmlabs::Parameter::removeItem

(

const JString &

value

)

Definition at line 435 of file Parameter.cpp.

---

Member Data Documentation

JString cmlabs::Parameter::name

Definition at line 69 of file Parameter.h.

JString cmlabs::Parameter::value

Definition at line 70 of file Parameter.h.

JString cmlabs::Parameter::defaultValue

Definition at line 71 of file Parameter.h.

JString cmlabs::Parameter::valueType

Definition at line 72 of file Parameter.h.

JString cmlabs::Parameter::parameterType

Definition at line 73 of file Parameter.h.

JString cmlabs::Parameter::notify

Definition at line 74 of file Parameter.h.

double cmlabs::Parameter::step

Definition at line 75 of file Parameter.h.

bool cmlabs::Parameter::locked

Definition at line 77 of file Parameter.h.

double cmlabs::Parameter::minValue

Definition at line 78 of file Parameter.h.

double cmlabs::Parameter::maxValue

Definition at line 78 of file Parameter.h.

Collection cmlabs::Parameter::values

Definition at line 104 of file Parameter.h.

int cmlabs::Parameter::current [protected]

Definition at line 108 of file Parameter.h.

int cmlabs::Parameter::def [protected]

Definition at line 109 of file Parameter.h.

---

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

• Parameter.h
• Parameter.cpp