WorldStateVelDaemon Class Reference
#include <WorldStateVelDaemon.h>
Inheritance diagram for WorldStateVelDaemon:
Detailed Description
Listens for LocomotionEvents and updates the velocity fields of WorldState.If we get multiple ways of locomoting, this would be a good place to manage them to determine the actual final velocity.
Right now it'll correctly handle one (or more i suppose) e-stops with a single other locomotor. But if there's two active locomotors, I dunno how to handle that.
Definition at line 19 of file WorldStateVelDaemon.h.
Public Member Functions | |
| WorldStateVelDaemon () | |
| 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 bool | trapEvent (const EventBase &e) |
| traps locomotion events - will filter them out if currently in EStop | |
| 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 | |
| unsigned int | estopTime |
| time estop activation was received | |
| float | old_x |
| current velocity of underlying locomotor | |
| float | old_y |
| current velocity of underlying locomotor | |
| float | old_a |
| current velocity of underlying locomotor | |
Member Function Documentation
| static std::string WorldStateVelDaemon::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 WorldStateVelDaemon.h.
Referenced by getDescription().
| virtual std::string WorldStateVelDaemon::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 WorldStateVelDaemon.h.
The documentation for this class was generated from the following file:
