Homepage Demos Overview Downloads Tutorials Reference
Credits

StareAtPawBehavior2 Class Reference

#include <StareAtPawBehavior2.h>

Inheritance diagram for StareAtPawBehavior2:

Inheritance graph
[legend]
List of all members.

Detailed Description

Uses kinematics to track the paw which last received a button press with the camera.

Definition at line 17 of file StareAtPawBehavior2.h.

Public Member Functions

 StareAtPawBehavior2 ()
 constructor
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 &e)
 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

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

LegOrder_t lastLeg
MotionManager::MC_ID pointID


Constructor & Destructor Documentation

StareAtPawBehavior2::StareAtPawBehavior2  )  [inline]
 

constructor

Definition at line 20 of file StareAtPawBehavior2.h.


Member Function Documentation

virtual void StareAtPawBehavior2::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 24 of file StareAtPawBehavior2.h.

virtual void StareAtPawBehavior2::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 36 of file StareAtPawBehavior2.h.

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

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

If you do override this, also consider overriding getDescription() to return it

Reimplemented from BehaviorBase.

Definition at line 81 of file StareAtPawBehavior2.h.

Referenced by getDescription().

virtual std::string StareAtPawBehavior2::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 82 of file StareAtPawBehavior2.h.

virtual void StareAtPawBehavior2::processEvent const EventBase e  )  [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 43 of file StareAtPawBehavior2.h.


Member Data Documentation

LegOrder_t StareAtPawBehavior2::lastLeg [protected]
 

Definition at line 85 of file StareAtPawBehavior2.h.

Referenced by processEvent(), and StareAtPawBehavior2().

MotionManager::MC_ID StareAtPawBehavior2::pointID [protected]
 

Definition at line 86 of file StareAtPawBehavior2.h.

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


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

Tekkotsu v2.2.1
Generated Tue Nov 23 16:37:53 2004 by Doxygen 1.3.9.1