BehaviorSwitchControlBase Class Reference#include <BehaviorSwitchControl.h>
Inheritance diagram for BehaviorSwitchControlBase:
[legend]List of all members.
Detailed Description
Holds some utility classes and functions for BehaviorSwitchControl which shouldn't be stored in a templated class.
Definition at line 12 of file BehaviorSwitchControl.h.
|
Public Member Functions |
| BehaviorSwitchControlBase (const std::string &n, BehaviorBase *beh, BehaviorGroup *bg=NULL) |
| constructor
|
| BehaviorSwitchControlBase (BehaviorBase *beh, BehaviorGroup *bg=NULL) |
| constructor
|
virtual | ~BehaviorSwitchControlBase () |
| destructor
|
virtual BehaviorSwitchControlBase * | start () |
| activates the behavior, handy for making start-up behaviors that you can turn off again with the Controller
|
virtual BehaviorSwitchControlBase * | stop () |
| stops the behavior
|
virtual BehaviorSwitchControlBase * | toggle () |
| toggles the behavior
|
virtual ControlBase * | activate (MotionManager::MC_ID display, Socket *gui) |
| tells the current behavior (if there is one) to stop then loads its own
|
virtual std::string | getName () const |
| adds a status to the name: - if in memory, # if running
|
virtual std::string | getDescription () const |
| returns a short description of what the control does
|
Protected Member Functions |
virtual void | stopother () |
| Stops the "other" guy's behavior - if ::behgrp is NULL, stops ourselves.
|
virtual void | startmine () |
| Starts our behavior.
|
virtual bool | isRunning () const |
| Returns true if the associated behavior is running.
|
Protected Attributes |
BehaviorGroup * | behgrp |
| the behavior group this belongs to. Uses this to track the "current" behavior
|
BehaviorBase * | mybeh |
| used to store the behavior. If retained and non-NULL, will be valid. However, if not retained, only valid if equals behgrp->curBehavior
|
Private Member Functions |
| BehaviorSwitchControlBase (const BehaviorSwitchControlBase &) |
| shouldn't copy these
|
BehaviorSwitchControlBase | operator= (const BehaviorSwitchControlBase &) |
| shouldn't assign these
|
Constructor & Destructor Documentation
BehaviorSwitchControlBase::BehaviorSwitchControlBase |
( |
const std::string & |
n, |
|
|
BehaviorBase * |
beh, |
|
|
BehaviorGroup * |
bg = NULL |
|
) |
[inline] |
|
Member Function Documentation
|
tells the current behavior (if there is one) to stop then loads its own
- Returns:
- NULL unless there are submenus
Reimplemented from ControlBase.
Definition at line 72 of file BehaviorSwitchControl.h. |
virtual std::string BehaviorSwitchControlBase::getDescription |
( |
|
) |
const [inline, virtual] |
|
virtual std::string BehaviorSwitchControlBase::getName |
( |
|
) |
const [inline, virtual] |
|
virtual bool BehaviorSwitchControlBase::isRunning |
( |
|
) |
const [inline, protected, virtual] |
|
virtual void BehaviorSwitchControlBase::startmine |
( |
|
) |
[inline, protected, virtual] |
|
virtual void BehaviorSwitchControlBase::stopother |
( |
|
) |
[inline, protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
|