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

BehaviorActivatorControl Class Reference

#include <BehaviorActivatorControl.h>

Inheritance diagram for BehaviorActivatorControl:

Inheritance graph
[legend]
List of all members.

Detailed Description

Upon activation, will start, stop, or toggle a behavior.

Definition at line 8 of file BehaviorActivatorControl.h.

Public Types

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


Public Member Functions

virtual ~BehaviorActivatorControl ()
 destructor

virtual ControlBaseactivate (MotionManager::MC_ID disp_id, Socket *gui)
 performs the action denoted by mode

 BehaviorActivatorControl (BehaviorBase *behave, Mode_t m=toggle)
 constructors

 BehaviorActivatorControl (const std::string &n, BehaviorBase *behave, Mode_t m=toggle)
 constructors

 BehaviorActivatorControl (const std::string &n, const std::string &d, BehaviorBase *behave, Mode_t m=toggle)
 constructors


Protected Member Functions

void init ()
 adds to target's reference counter


Protected Attributes

BehaviorBasetarget
 The behavior to activate/deactivate.

Mode_t mode
 the mode this control is in


Private Member Functions

 BehaviorActivatorControl (const BehaviorActivatorControl &)
 don't copy this class

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


Member Enumeration Documentation

enum BehaviorActivatorControl::Mode_t
 

lets you tell it what action to perform

Enumeration values:
start 
stop 
toggle 

Definition at line 11 of file BehaviorActivatorControl.h.


Constructor & Destructor Documentation

BehaviorActivatorControl::BehaviorActivatorControl BehaviorBase behave,
Mode_t  m = toggle
[inline]
 

constructors

Definition at line 15 of file BehaviorActivatorControl.h.

References init(), mode, start, target, and toggle.

BehaviorActivatorControl::BehaviorActivatorControl const std::string &  n,
BehaviorBase behave,
Mode_t  m = toggle
[inline]
 

constructors

Definition at line 16 of file BehaviorActivatorControl.h.

References init(), mode, start, target, and toggle.

BehaviorActivatorControl::BehaviorActivatorControl const std::string &  n,
const std::string &  d,
BehaviorBase behave,
Mode_t  m = toggle
[inline]
 

constructors

Definition at line 17 of file BehaviorActivatorControl.h.

References init(), mode, and target.

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

destructor

Definition at line 21 of file BehaviorActivatorControl.h.

References ReferenceCounter::RemoveReference(), and target.

BehaviorActivatorControl::BehaviorActivatorControl const BehaviorActivatorControl  )  [private]
 

don't copy this class


Member Function Documentation

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

performs the action denoted by mode

Reimplemented from NullControl.

Definition at line 24 of file BehaviorActivatorControl.h.

References NullControl::activate(), BehaviorBase::DoStart(), BehaviorBase::DoStop(), BehaviorBase::isActive(), mode, start, stop, target, and toggle.

void BehaviorActivatorControl::init  )  [inline, protected]
 

adds to target's reference counter

Definition at line 48 of file BehaviorActivatorControl.h.

References ReferenceCounter::AddReference(), and target.

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

don't assign this class


Member Data Documentation

Mode_t BehaviorActivatorControl::mode [protected]
 

the mode this control is in

Definition at line 53 of file BehaviorActivatorControl.h.

BehaviorBase* BehaviorActivatorControl::target [protected]
 

The behavior to activate/deactivate.

Definition at line 52 of file BehaviorActivatorControl.h.


The documentation for this class was generated from the following file:
Tekkotsu v1.4
Generated Sat Jul 19 00:08:50 2003 by Doxygen 1.3.2