StepTest Class Reference#include <StepTest.h>
Inheritance diagram for StepTest:
[legend]List of all members.
Detailed Description
tests taking a certain number of steps
Definition at line 13 of file StepTest.h.
|
Public Member Functions |
| StepTest () |
| 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 |
MotionManager::MC_ID | walk_id |
| the WalkMC to use for the stepping
|
Constructor & Destructor Documentation
StepTest::StepTest |
( |
|
) |
[inline] |
|
Member Function Documentation
virtual void StepTest::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 18 of file StepTest.h. |
virtual void StepTest::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 24 of file StepTest.h. |
static std::string StepTest::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 57 of file StepTest.h.
Referenced by getDescription(). |
virtual std::string StepTest::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 58 of file StepTest.h. |
virtual void StepTest::processEvent |
( |
const EventBase & |
e |
) |
[inline, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
|