Homepage Demos Overview Downloads Tutorials Reference
Credits

HeadLevelBehavior Class Reference

#include <HeadLevelBehavior.h>

Inheritance diagram for HeadLevelBehavior:

Inheritance graph
[legend]
List of all members.

Detailed Description

Tests the head leveling code of HeadPointerMC.

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 getName () const
 Identifies the behavior in menus and such.


Static Public Member Functions

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< HeadPointerMChead
 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]
 

constructor

Definition at line 19 of file HeadLevelBehavior.h.

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

destructor

Definition at line 39 of file HeadLevelBehavior.h.


Member Function Documentation

virtual void HeadLevelBehavior::DoStart  )  [inline, virtual]
 

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.

Definition at line 43 of file HeadLevelBehavior.h.

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.

std::string HeadLevelBehavior::getClassDescription  )  [inline, static]
 

Gives a short description of what this class of behaviors does... you should override this (but don't have to).

Reimplemented from BehaviorBase.

Definition at line 73 of file HeadLevelBehavior.h.

virtual std::string HeadLevelBehavior::getName  )  const [inline, virtual]
 

Identifies the behavior in menus and such.

Implements BehaviorBase.

Definition at line 72 of file HeadLevelBehavior.h.

virtual void HeadLevelBehavior::processEvent const EventBase event  )  [inline, virtual]
 

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 60 of file HeadLevelBehavior.h.


Member Data Documentation

const SharedObject<HeadPointerMC> HeadLevelBehavior::head [protected]
 

might as well just hang on to the whole memory region and reuse it, we can peek for most of our stuff

Definition at line 78 of file HeadLevelBehavior.h.

Referenced by DoStart(), DoStop(), HeadLevelBehavior(), processEvent(), and ~HeadLevelBehavior().

MotionManager::MC_ID HeadLevelBehavior::head_id [protected]
 

MCID of headpointer.

Definition at line 79 of file HeadLevelBehavior.h.

Referenced by DoStart(), DoStop(), and HeadLevelBehavior().

EventBase HeadLevelBehavior::head_lock [protected]
 

event mask for locking head (chin button up)

Definition at line 77 of file HeadLevelBehavior.h.

Referenced by DoStart(), HeadLevelBehavior(), and processEvent().

EventBase HeadLevelBehavior::head_release [protected]
 

event mask for releasing head (chin button down)

Definition at line 76 of file HeadLevelBehavior.h.

Referenced by DoStart(), HeadLevelBehavior(), and processEvent().

MotionManager::MC_ID HeadLevelBehavior::pid_id [protected]
 

MCID of pid controller.

Definition at line 80 of file HeadLevelBehavior.h.

Referenced by HeadLevelBehavior(), and processEvent().


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

Tekkotsu v2.1
Generated Tue Mar 16 23:22:11 2004 by Doxygen 1.3.5