Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

ValueSetControl< T > Class Template Reference

#include <ValueSetControl.h>

Inheritance diagram for ValueSetControl< T >:

List of all members.


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.


Public Member Functions

virtual ControlBaseactivate (MotionManager::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 ValueSetControlsetTarget (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 ValueSetControlsetDefault (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)
def
 the value that will be assigned to target upon a call to activate()

Constructor & Destructor Documentation

template<class T>
ValueSetControl< T >::ValueSetControl (  )  [inline]

constructor

Definition at line 13 of file ValueSetControl.h.

template<class T>
ValueSetControl< T >::ValueSetControl ( const std::string &  n,
T *  t 
) [inline]

constructor

Definition at line 14 of file ValueSetControl.h.

template<class T>
ValueSetControl< T >::ValueSetControl ( const std::string &  n,
T *  t,
const T &  d 
) [inline]

constructor

Definition at line 15 of file ValueSetControl.h.

template<class T>
ValueSetControl< T >::ValueSetControl ( const ValueSetControl< T > &  vsc  )  [inline]

copy constructor

Definition at line 16 of file ValueSetControl.h.

template<class T>
virtual ValueSetControl< T >::~ValueSetControl (  )  [inline, virtual]

destructor

Definition at line 18 of file ValueSetControl.h.


Member Function Documentation

template<class T>
ValueSetControl ValueSetControl< T >::operator= ( const ValueSetControl< T > &  vsc  )  [inline]

assignment operator

Definition at line 17 of file ValueSetControl.h.

template<class T>
virtual ControlBase* ValueSetControl< T >::activate ( MotionManager::MC_ID  display  )  [inline, 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 T* ValueSetControl< T >::getTarget (  )  const [inline, virtual]

returns the target pointer

Definition at line 32 of file ValueSetControl.h.

template<class T>
virtual ValueSetControl& ValueSetControl< T >::setTarget ( T *  t  )  [inline, virtual]

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

Definition at line 33 of file ValueSetControl.h.

template<class T>
virtual T& ValueSetControl< T >::getDefault (  )  [inline, virtual]

gets reference to default value

Definition at line 38 of file ValueSetControl.h.

template<class T>
virtual const T& ValueSetControl< T >::getDefault (  )  const [inline, virtual]

gets reference to default value

Definition at line 39 of file ValueSetControl.h.

template<class T>
virtual ValueSetControl& ValueSetControl< T >::setDefault ( const T &  d  )  [inline, virtual]

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

Definition at line 40 of file ValueSetControl.h.


Member Data Documentation

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().

template<class T>
T ValueSetControl< T >::def [protected]


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:46 2007 by Doxygen 1.5.4