Homepage Demos Overview Downloads Tutorials Reference
Credits

GroundPlaneBehavior Class Reference

#include <GroundPlaneBehavior.h>

Inheritance diagram for GroundPlaneBehavior:

Inheritance graph
[legend]
List of all members.

Detailed Description

Reports the location of the center of the camera image on the ground plane.

Definition at line 15 of file GroundPlaneBehavior.h.

Public Member Functions

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

EventBase head_release
EventBase head_lock
EventBase clock


Constructor & Destructor Documentation

GroundPlaneBehavior::GroundPlaneBehavior  )  [inline]
 

constructor

Definition at line 18 of file GroundPlaneBehavior.h.


Member Function Documentation

virtual void GroundPlaneBehavior::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 25 of file GroundPlaneBehavior.h.

virtual void GroundPlaneBehavior::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 32 of file GroundPlaneBehavior.h.

std::string GroundPlaneBehavior::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 74 of file GroundPlaneBehavior.h.

Referenced by getDescription().

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

virtual void GroundPlaneBehavior::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 37 of file GroundPlaneBehavior.h.

Referenced by DoStart().


Member Data Documentation

EventBase GroundPlaneBehavior::clock [protected]
 

Definition at line 78 of file GroundPlaneBehavior.h.

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

EventBase GroundPlaneBehavior::head_lock [protected]
 

Definition at line 78 of file GroundPlaneBehavior.h.

Referenced by DoStart(), and GroundPlaneBehavior().

EventBase GroundPlaneBehavior::head_release [protected]
 

Definition at line 78 of file GroundPlaneBehavior.h.

Referenced by DoStart(), and GroundPlaneBehavior().


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

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