BehaviorSwitchActivatorControl Class Reference
#include <BehaviorSwitchActivatorControl.h>
Inheritance diagram for BehaviorSwitchActivatorControl:
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 | |
| start | |
| Passed to constructor, indicates this control should start the behavior when activated. | |
| stop | |
| Passed to constructor, indicates this control should stop the behavior when activated. | |
| toggle | |
| Passed to constructor, indicates this control should toggle the behavior when activated. | |
| 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 ControlBase * | activate (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 | |
| BehaviorSwitchControlBase * | behswitch |
| 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
lets you tell it what action to perform
- Enumerator:
Definition at line 12 of file BehaviorSwitchActivatorControl.h.
Constructor & Destructor Documentation
| BehaviorSwitchActivatorControl::BehaviorSwitchActivatorControl | ( | const std::string & | n, | |
| BehaviorSwitchControlBase * | bscb, | |||
| Mode_t | m = toggle | |||
| ) | [inline] |
| virtual BehaviorSwitchActivatorControl::~BehaviorSwitchActivatorControl | ( | ) | [inline, virtual] |
| 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] |
| virtual std::string BehaviorSwitchActivatorControl::getDescription | ( | ) | const [inline, virtual] |
returns a short description of what the control does
Reimplemented from ControlBase.
Definition at line 45 of file BehaviorSwitchActivatorControl.h.
| virtual std::string BehaviorSwitchActivatorControl::getName | ( | ) | const [inline, virtual] |
returns the name of the control
Reimplemented from ControlBase.
Definition at line 44 of file BehaviorSwitchActivatorControl.h.
| BehaviorSwitchActivatorControl BehaviorSwitchActivatorControl::operator= | ( | const BehaviorSwitchActivatorControl & | ) | [private] |
don't assign this class
Member Data Documentation
The behavior switch to activate/deactivate.
Definition at line 48 of file BehaviorSwitchActivatorControl.h.
Referenced by activate(), getDescription(), and getName().
Mode_t BehaviorSwitchActivatorControl::mode [protected] |
the mode this control is in
Definition at line 49 of file BehaviorSwitchActivatorControl.h.
Referenced by activate().
The documentation for this class was generated from the following file:
