GroundPlaneBehavior Class Reference#include <GroundPlaneBehavior.h>
Inheritance diagram for GroundPlaneBehavior:
[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 |
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 template to match to signal the head's PID joints should be relaxed
|
EventBase | head_lock |
| event template to match to signal the head's PID joints should be powered up again
|
EventBase | clock |
| event template to match to signal a new round of calculations should be performed
|
Constructor & Destructor Documentation
GroundPlaneBehavior::GroundPlaneBehavior |
( |
|
) |
[inline] |
|
Member Function Documentation
virtual void GroundPlaneBehavior::DoStart |
( |
|
) |
[inline, virtual] |
|
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. |
static std::string GroundPlaneBehavior::getClassDescription |
( |
|
) |
[inline, static] |
|
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] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
|