Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

BehaviorSwitchControl< B, Al > Class Template Reference

#include <BehaviorSwitchControl.h>

Inheritance diagram for BehaviorSwitchControl< B, Al >:

List of all members.


Detailed Description

template<class B, class Al = typename Factory0Arg<B>::template 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
BehaviorBasestartref
 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

Constructor & Destructor Documentation

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorSwitchControl< B, Al >::BehaviorSwitchControl ( const std::string &  n,
bool  retain = false 
) [inline]

constructor, can use this to toggle a single behavior on and off

Definition at line 185 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorSwitchControl< B, Al >::BehaviorSwitchControl ( B *  beh,
BehaviorGroup bg = NULL 
) [inline]

constructor, if you want to use an already constructed behavior

Definition at line 189 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorSwitchControl< B, Al >::BehaviorSwitchControl ( const std::string &  n,
B *  beh,
BehaviorGroup bg = NULL,
bool  retain = false 
) [inline]

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)

Definition at line 193 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorSwitchControl< B, Al >::BehaviorSwitchControl ( const std::string &  n,
BehaviorGroup bg,
bool  retain = false 
) [inline]

constructor, needs to know what group its in and whether to retain its behavior

Definition at line 205 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual BehaviorSwitchControl< B, Al >::~BehaviorSwitchControl (  )  [inline, virtual]

destructor

Definition at line 210 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorSwitchControl< B, Al >::BehaviorSwitchControl ( const BehaviorSwitchControl< B, Al > &   )  [private]

shouldn't call this


Member Function Documentation

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual std::string BehaviorSwitchControl< B, Al >::getName (  )  const [inline, virtual]

adds a status to the name: - if in memory, # if running

Reimplemented from BehaviorSwitchControlBase.

Definition at line 222 of file BehaviorSwitchControl.h.

Referenced by BehaviorSwitchControl< B, Al >::startmine().

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual std::string BehaviorSwitchControl< B, Al >::getDescription (  )  const [inline, virtual]

returns a short description of what the control does

Reimplemented from BehaviorSwitchControlBase.

Definition at line 228 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual void BehaviorSwitchControl< B, Al >::startmine (  )  [inline, protected, virtual]

Starts our behavior.

Reimplemented from BehaviorSwitchControlBase.

Definition at line 237 of file BehaviorSwitchControl.h.

Referenced by BehaviorSwitchControl< B, Al >::BehaviorSwitchControl().

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual bool BehaviorSwitchControl< B, Al >::isRunning (  )  const [inline, protected, virtual]

adds a check to see if behavior has stopped itself -- if so, remove startref

Reimplemented from BehaviorSwitchControlBase.

Definition at line 260 of file BehaviorSwitchControl.h.

Referenced by BehaviorSwitchControl< B, Al >::isValid().

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual bool BehaviorSwitchControl< B, Al >::isValid (  )  const [inline, protected, virtual]

Returns true if mybeh is pointing to a valid object.

Definition at line 269 of file BehaviorSwitchControl.h.

Referenced by BehaviorSwitchControl< B, Al >::getDescription(), and BehaviorSwitchControl< B, Al >::getName().

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
virtual void BehaviorSwitchControl< B, Al >::behaviorStopped (  )  [inline, protected, virtual]

called by notifyGroupMembers if mybeh was destructed when stopped

Reimplemented from BehaviorSwitchControlBase.

Definition at line 275 of file BehaviorSwitchControl.h.

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorSwitchControl BehaviorSwitchControl< B, Al >::operator= ( const BehaviorSwitchControl< B, Al > &   )  [private]

shouldn't call this


Member Data Documentation

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
bool BehaviorSwitchControl< B, Al >::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 284 of file BehaviorSwitchControl.h.

Referenced by BehaviorSwitchControl< B, Al >::behaviorStopped(), BehaviorSwitchControl< B, Al >::BehaviorSwitchControl(), BehaviorSwitchControl< B, Al >::isValid(), BehaviorSwitchControl< B, Al >::startmine(), and BehaviorSwitchControl< B, Al >::~BehaviorSwitchControl().

template<class B, class Al = typename Factory0Arg<B>::template Factory<B>>
BehaviorBase* BehaviorSwitchControl< B, Al >::startref [protected]

true if a reference was added (and still current) from calling DoStart

Definition at line 285 of file BehaviorSwitchControl.h.

Referenced by BehaviorSwitchControl< B, Al >::behaviorStopped(), BehaviorSwitchControl< B, Al >::isRunning(), and BehaviorSwitchControl< B, Al >::startmine().


The documentation for this class was generated from the following file:

Tekkotsu v4.0
Generated Thu Nov 22 00:58:11 2007 by Doxygen 1.5.4