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

BehaviorSwitchControlBase Class Reference

#include <BehaviorSwitchControl.h>

Inheritance diagram for BehaviorSwitchControlBase:

Inheritance graph
[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, BehaviorGroup *bg, bool retain)
 constructor

virtual ~BehaviorSwitchControlBase ()
 destructor

virtual BehaviorSwitchControlBase * start ()=0
 activates the behavior, handy for making start-up behaviors that you can turn off again with the Controller

virtual BehaviorSwitchControlBase * stop ()=0
 stops the behavior

virtual BehaviorSwitchControlBase * toggle ()=0
 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


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

BehaviorGroup * behgrp
 the behavior group this belongs to. Uses this to track the "current" behavior


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,
BehaviorGroup *  bg,
bool  retain
)  [inline]
 

constructor

Definition at line 32 of file BehaviorSwitchControl.h.

References ReferenceCounter::AddReference(), behgrp, and retained.

Here is the call graph for this function:

virtual BehaviorSwitchControlBase::~BehaviorSwitchControlBase (   )  [inline, virtual]
 

destructor

Definition at line 40 of file BehaviorSwitchControl.h.

References behgrp, and ReferenceCounter::RemoveReference().

Here is the call graph for this function:

BehaviorSwitchControlBase::BehaviorSwitchControlBase (  const BehaviorSwitchControlBase &   )  [private]
 

shouldn't copy these

Member Function Documentation

virtual ControlBase* BehaviorSwitchControlBase::activate (  MotionManager::MC_ID  display,
Socket *  gui
)  [inline, virtual]
 

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 53 of file BehaviorSwitchControl.h.

References ControlBase::activate(), MotionManager::MC_ID, ControlBase::slotsSize(), and toggle().

Here is the call graph for this function:

BehaviorSwitchControlBase BehaviorSwitchControlBase::operator= (  const BehaviorSwitchControlBase &   )  [private]
 

shouldn't assign these

virtual BehaviorSwitchControlBase* BehaviorSwitchControlBase::start (   )  [pure virtual]
 

activates the behavior, handy for making start-up behaviors that you can turn off again with the Controller

If you start twice without stopping (ie it's already running), shouldn't do anything

Implemented in BehaviorSwitchControl< B, Al >.

virtual BehaviorSwitchControlBase* BehaviorSwitchControlBase::stop (   )  [pure virtual]
 

stops the behavior

Implemented in BehaviorSwitchControl< B, Al >.

virtual BehaviorSwitchControlBase* BehaviorSwitchControlBase::toggle (   )  [pure virtual]
 

toggles the behavior

Implemented in BehaviorSwitchControl< B, Al >.

Member Data Documentation

BehaviorGroup* BehaviorSwitchControlBase::behgrp [protected]
 

the behavior group this belongs to. Uses this to track the "current" behavior

Definition at line 63 of file BehaviorSwitchControl.h.

bool BehaviorSwitchControlBase::retained [protected]
 

true if the behavior should be generated once and retained after DoStop. Otherwise, a new one is generated each time it is started

Definition at line 62 of file BehaviorSwitchControl.h.

The documentation for this class was generated from the following file:
Tekkotsu v1.5
 		Generated Fri Oct 10 15:55:14 2003 by Doxygen 1.3.4