BehaviorSwitchControl< B, Al > Class Template Reference
#include <BehaviorSwitchControl.h>
Inheritance diagram for BehaviorSwitchControl< B, Al >:
Detailed Description
template<class B, class Al = Factory< B >>
class BehaviorSwitchControl< B, Al >
Allows proper switching between major behaviors, calling DoStart and DoStop.
Definition at line 182 of file BehaviorSwitchControl.h.
Public Member Functions | |
| BehaviorSwitchControl (const std::string &n, bool retain=false) | |
| constructor, can use this to toggle a single behavior on and off | |
| BehaviorSwitchControl (B *beh, BehaviorGroup *bg=NULL) | |
| constructor, if you want to use an already constructed behavior | |
| BehaviorSwitchControl (const std::string &n, B *beh, BehaviorGroup *bg=NULL, bool retain=false) | |
| constructor, if you want to use an already constructed behavior, but unretain it if it's stopped (if not retaining, will start beh if it's not already started) | |
| BehaviorSwitchControl (const std::string &n, BehaviorGroup *bg, bool retain=false) | |
| constructor, needs to know what group its in and whether to retain its behavior | |
| virtual | ~BehaviorSwitchControl () |
| destructor | |
| 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 | startmine () |
| Starts our behavior. | |
| virtual bool | isRunning () const |
| adds a check to see if behavior has stopped itself -- if so, remove startref | |
| virtual bool | isValid () const |
| Returns true if mybeh is pointing to a valid object. | |
| virtual void | behaviorStopped () |
| called by notifyGroupMembers if mybeh was destructed when stopped | |
Protected Attributes | |
| bool | retained |
| true if the behavior should be generated once and retained after DoStop. Otherwise, a new one is generated each time it is started | |
| BehaviorBase * | startref |
| true if a reference was added (and still current) from calling DoStart | |
Private Member Functions | |
| BehaviorSwitchControl (const BehaviorSwitchControl &) | |
| shouldn't call this | |
| BehaviorSwitchControl | operator= (const BehaviorSwitchControl &) |
| shouldn't call this | |
The documentation for this class was generated from the following file:
