Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

AlanBehavior Class Reference

#include <AlanBehavior.h>

Inheritance diagram for AlanBehavior:

Inheritance graph
[legend]
List of all members.

Detailed Description

just a little demo behavior which lifts a leg higher as more pressure is put on a head button

Based on an idea from Alan Chun-ho Ho for a basic demo program

Definition at line 17 of file AlanBehavior.h.

Public Member Functions

 AlanBehavior ()
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

MotionManager::MC_ID pose_id
 ID of PostureMC, set up in DoStart() and used in processEvent().


Constructor & Destructor Documentation

AlanBehavior::AlanBehavior  )  [inline]
 

Definition at line 19 of file AlanBehavior.h.


Member Function Documentation

virtual void AlanBehavior::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 23 of file AlanBehavior.h.

virtual void AlanBehavior::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 35 of file AlanBehavior.h.

static std::string AlanBehavior::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 100 of file AlanBehavior.h.

Referenced by getDescription().

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

virtual void AlanBehavior::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 44 of file AlanBehavior.h.


Member Data Documentation

MotionManager::MC_ID AlanBehavior::pose_id [protected]
 

ID of PostureMC, set up in DoStart() and used in processEvent().

Definition at line 110 of file AlanBehavior.h.

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


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

Tekkotsu v2.4.1
Generated Tue Aug 16 16:34:56 2005 by Doxygen 1.4.4