ValueSetControl< T > Class Template Reference

Upon activation, this control will set the target pointer to the specified value. More...

#include <ValueSetControl.h>

Inheritance diagram for ValueSetControl< T >:

[legend]

---

Detailed Description

template<class T>
class ValueSetControl< T >

Upon activation, this control will set the target pointer to the specified value.

Definition at line 9 of file ValueSetControl.h.

List of all members.

Public Member Functions
virtual ControlBase *	activate (MC_ID display)
	assigns def to object pointed to by target
Constructors/Destructors
	ValueSetControl ()
	constructor
	ValueSetControl (const std::string &n, T *t)
	constructor
	ValueSetControl (const std::string &n, T *t, const T &d)
	constructor
	ValueSetControl (const ValueSetControl &vsc)
	copy constructor
ValueSetControl	operator= (const ValueSetControl &vsc)
	assignment operator
virtual	~ValueSetControl ()
	destructor
Target
accessors for the target pointer
virtual T *	getTarget () const
	returns the target pointer
virtual ValueSetControl &	setTarget (T *t)
	sets the target pointer - the object pointed to will be overwritten on activate(); returns *this
Value
accessors for the default value assigned when activated
virtual T &	getDefault ()
	gets reference to default value
virtual const T &	getDefault () const
	gets reference to default value
virtual ValueSetControl &	setDefault (const T &d)
	assigns d to the default value (not to the target, yet); returns *this
Protected Attributes
T *	target
	the target that will be set to the default value (def)
T	def
	the value that will be assigned to target upon a call to activate()

---

Constructor & Destructor Documentation

template<class T >

ValueSetControl< T >::ValueSetControl

(

)

constructor

Definition at line 13 of file ValueSetControl.h.

template<class T >

ValueSetControl< T >::ValueSetControl	(	const std::string &	n,
		T *	t
	)

constructor

Definition at line 14 of file ValueSetControl.h.

template<class T >

ValueSetControl< T >::ValueSetControl	(	const std::string &	n,
		T *	t,
		const T &	d
	)

constructor

Definition at line 15 of file ValueSetControl.h.

template<class T >

ValueSetControl< T >::ValueSetControl

(

const ValueSetControl< T > &

vsc

)

copy constructor

Definition at line 16 of file ValueSetControl.h.

template<class T >

virtual ValueSetControl< T >::~ValueSetControl

(

)

[virtual]

destructor

Definition at line 18 of file ValueSetControl.h.

---

Member Function Documentation

template<class T >

virtual ControlBase* ValueSetControl< T >::activate

(

MC_ID

display

)

[virtual]

assigns def to object pointed to by target

Todo:

make the leds flash

Definition at line 22 of file ValueSetControl.h.

template<class T >

virtual const T& ValueSetControl< T >::getDefault

(

)

const [virtual]

gets reference to default value

Definition at line 39 of file ValueSetControl.h.

template<class T >

virtual T& ValueSetControl< T >::getDefault

(

)

[virtual]

gets reference to default value

Definition at line 38 of file ValueSetControl.h.

template<class T >

virtual T* ValueSetControl< T >::getTarget

(

)

const [virtual]

returns the target pointer

Definition at line 32 of file ValueSetControl.h.

template<class T >

ValueSetControl ValueSetControl< T >::operator=

(

const ValueSetControl< T > &

vsc

)

assignment operator

Definition at line 17 of file ValueSetControl.h.

template<class T >

virtual ValueSetControl& ValueSetControl< T >::setDefault

(

const T &

d

)

[virtual]

assigns d to the default value (not to the target, yet); returns *this

Definition at line 40 of file ValueSetControl.h.

template<class T >

virtual ValueSetControl& ValueSetControl< T >::setTarget

(

T *

t

)

[virtual]

sets the target pointer - the object pointed to will be overwritten on activate(); returns *this

Definition at line 33 of file ValueSetControl.h.

---

Member Data Documentation

template<class T >

T ValueSetControl< T >::def [protected]

the value that will be assigned to target upon a call to activate()

Definition at line 45 of file ValueSetControl.h.

Referenced by ValueSetControl< T >::activate(), ValueSetControl< T >::getDefault(), ValueSetControl< T >::operator=(), and ValueSetControl< T >::setDefault().

template<class T >

T* ValueSetControl< T >::target [protected]

the target that will be set to the default value (def)

Definition at line 44 of file ValueSetControl.h.

Referenced by ValueSetControl< T >::activate(), ValueSetControl< T >::getTarget(), ValueSetControl< T >::operator=(), and ValueSetControl< T >::setTarget().

---

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

• ValueSetControl.h