Homepage Demos Overview Downloads Tutorials Reference
Credits

BehaviorSwitchActivatorControl Class Reference

#include <BehaviorSwitchActivatorControl.h>

Inheritance diagram for BehaviorSwitchActivatorControl:

Inheritance graph
[legend]
List of all members.

Detailed Description

Upon activation, will tell the specified BehaviorSwitchControl to start or stop the behavior.

Definition at line 9 of file BehaviorSwitchActivatorControl.h.

Public Types

enum  Mode_t { start, stop, toggle }
 lets you tell it what action to perform More...

Public Member Functions

 BehaviorSwitchActivatorControl (const std::string &n, BehaviorSwitchControlBase *bscb, Mode_t m=toggle)
 constructor
virtual ~BehaviorSwitchActivatorControl ()
 destructor
virtual ControlBaseactivate (MotionManager::MC_ID disp_id, Socket *)
 performs the action denoted by mode
virtual std::string getName () const
 returns the name of the control
virtual std::string getDescription () const
 returns a short description of what the control does

Protected Attributes

BehaviorSwitchControlBasebehswitch
 The behavior switch to activate/deactivate.
Mode_t mode
 the mode this control is in

Private Member Functions

 BehaviorSwitchActivatorControl (const BehaviorSwitchActivatorControl &)
 don't copy this class
BehaviorSwitchActivatorControl operator= (const BehaviorSwitchActivatorControl &)
 don't assign this class


Member Enumeration Documentation

enum BehaviorSwitchActivatorControl::Mode_t
 

lets you tell it what action to perform

Enumeration values:
start 
stop 
toggle 

Definition at line 12 of file BehaviorSwitchActivatorControl.h.


Constructor & Destructor Documentation

BehaviorSwitchActivatorControl::BehaviorSwitchActivatorControl const std::string &  n,
BehaviorSwitchControlBase bscb,
Mode_t  m = toggle
[inline]
 

constructor

Definition at line 15 of file BehaviorSwitchActivatorControl.h.

virtual BehaviorSwitchActivatorControl::~BehaviorSwitchActivatorControl  )  [inline, virtual]
 

destructor

Definition at line 18 of file BehaviorSwitchActivatorControl.h.

BehaviorSwitchActivatorControl::BehaviorSwitchActivatorControl const BehaviorSwitchActivatorControl  )  [private]
 

don't copy this class


Member Function Documentation

virtual ControlBase* BehaviorSwitchActivatorControl::activate MotionManager::MC_ID  disp_id,
Socket
[inline, virtual]
 

performs the action denoted by mode

Reimplemented from ControlBase.

Definition at line 21 of file BehaviorSwitchActivatorControl.h.

virtual std::string BehaviorSwitchActivatorControl::getDescription  )  const [inline, virtual]
 

returns a short description of what the control does

Reimplemented from ControlBase.

Definition at line 41 of file BehaviorSwitchActivatorControl.h.

virtual std::string BehaviorSwitchActivatorControl::getName  )  const [inline, virtual]
 

returns the name of the control

Reimplemented from ControlBase.

Definition at line 40 of file BehaviorSwitchActivatorControl.h.

BehaviorSwitchActivatorControl BehaviorSwitchActivatorControl::operator= const BehaviorSwitchActivatorControl  )  [private]
 

don't assign this class


Member Data Documentation

BehaviorSwitchControlBase* BehaviorSwitchActivatorControl::behswitch [protected]
 

The behavior switch to activate/deactivate.

Definition at line 44 of file BehaviorSwitchActivatorControl.h.

Referenced by activate(), BehaviorSwitchActivatorControl(), getDescription(), and getName().

Mode_t BehaviorSwitchActivatorControl::mode [protected]
 

the mode this control is in

Definition at line 45 of file BehaviorSwitchActivatorControl.h.

Referenced by BehaviorSwitchActivatorControl().


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

Tekkotsu v2.2
Generated Tue Oct 19 14:20:15 2004 by Doxygen 1.3.9.1