Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members | Related Pages | Search

ValueSetControl< T > Class Template Reference

#include <ValueSetControl.h>

Inheritance diagram for ValueSetControl< T >:

Inheritance graph
[legend]
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 ControlBase * activate (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 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 (   )  [inline]
 

constructor

Definition at line 13 of file ValueSetControl.h.

References ValueSetControl< T >::target.

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

constructor

Definition at line 14 of file ValueSetControl.h.

References ValueSetControl< T >::target.

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.

References ValueSetControl< T >::def, and ValueSetControl< T >::target.

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

copy constructor

Definition at line 16 of file ValueSetControl.h.

References ValueSetControl< T >::def, and ValueSetControl< T >::target.

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

destructor

Definition at line 18 of file ValueSetControl.h.

Member Function Documentation

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.

References ValueSetControl< T >::def, MotionManager::invalid_MC_ID, and ValueSetControl< T >::target.

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.

References ValueSetControl< T >::def.

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

gets reference to default value

Definition at line 38 of file ValueSetControl.h.

References ValueSetControl< T >::def.

template<class T>
virtual T* ValueSetControl< T >::getTarget (   )  const [inline, virtual]
 

returns the target pointer

Definition at line 32 of file ValueSetControl.h.

References ValueSetControl< T >::target.

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

assignment operator

Definition at line 17 of file ValueSetControl.h.

References ValueSetControl< T >::def, ControlBase::operator=(), and ValueSetControl< T >::target.

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.

References ValueSetControl< T >::def.

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.

References ValueSetControl< T >::target.

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.

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.

The documentation for this class was generated from the following file:
Tekkotsu v1.4
 		Generated Sat Jul 19 00:09:14 2003 by Doxygen 1.3.2