HeadLevelBehavior Class Reference#include <HeadLevelBehavior.h>
Inheritance diagram for HeadLevelBehavior:
[legend]List of all members.
Detailed Description
Tests the head leveling code of OldHeadPointerMC.
Definition at line 16 of file HeadLevelBehavior.h.
|
Public Member Functions |
| HeadLevelBehavior () |
| constructor
|
virtual | ~HeadLevelBehavior () |
| destructor
|
virtual void | DoStart () |
| By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.
|
virtual void | DoStop () |
| By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
|
virtual void | processEvent (const EventBase &event) |
| By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
|
virtual std::string | getDescription () const |
| Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).
|
Static Public Member Functions |
static std::string | getClassDescription () |
| Gives a short description of what this class of behaviors does... you should override this (but don't have to).
|
Protected Attributes |
EventBase | head_release |
| event mask for releasing head (chin button down)
|
EventBase | head_lock |
| event mask for locking head (chin button up)
|
const SharedObject< OldHeadPointerMC > | head |
| might as well just hang on to the whole memory region and reuse it, we can peek for most of our stuff
|
MotionManager::MC_ID | head_id |
| MCID of headpointer.
|
MotionManager::MC_ID | pid_id |
| MCID of pid controller.
|
Constructor & Destructor Documentation
HeadLevelBehavior::HeadLevelBehavior |
( |
|
) |
[inline] |
|
Member Function Documentation
virtual void HeadLevelBehavior::DoStart |
( |
|
) |
[inline, virtual] |
|
virtual void HeadLevelBehavior::DoStop |
( |
|
) |
[inline, virtual] |
|
|
By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
Reimplemented from BehaviorBase.
Definition at line 53 of file HeadLevelBehavior.h. |
static std::string HeadLevelBehavior::getClassDescription |
( |
|
) |
[inline, static] |
|
virtual std::string HeadLevelBehavior::getDescription |
( |
|
) |
const [inline, virtual] |
|
|
Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).
By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~::getClassDescription(), because static functions can't be virtual in C++ (doh!)
This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so.
Reimplemented from BehaviorBase.
Definition at line 73 of file HeadLevelBehavior.h. |
virtual void HeadLevelBehavior::processEvent |
( |
const EventBase & |
event |
) |
[inline, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
|