EStopControllerBehavior Class Reference
#include <EStopControllerBehavior.h>
Inheritance diagram for EStopControllerBehavior:
Detailed Description
Listens to control commands coming in from the command port for remotely controlling the head.
Definition at line 14 of file EStopControllerBehavior.h.
Public Member Functions | |
| EStopControllerBehavior (MotionManager::MC_ID estop) | |
| constructor | |
| virtual | ~EStopControllerBehavior () |
| destructor | |
| 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 &) |
| 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). | |
| virtual void | runCommand (const std::string &s) |
| processes a string received from wireless | |
Static Public Member Functions | |
| static int | callback (char *buf, int bytes) |
| called by wireless when there's new data | |
| static std::string | getClassDescription () |
| Gives a short description of what this class of behaviors does... you should override this (but don't have to). | |
Static Public Attributes | |
| static EStopControllerBehavior * | theOne = NULL |
| Points to the one EStopControllerBehavior object that the input command stream is talking to. | |
Protected Attributes | |
| Socket * | cmdsock |
| The input command stream socket. | |
| MotionManager::MC_ID | estop_id |
| The estop to control. | |
Private Member Functions | |
| EStopControllerBehavior (const EStopControllerBehavior &) | |
| don't call | |
| EStopControllerBehavior | operator= (const EStopControllerBehavior &) |
| don't call | |
Member Function Documentation
| static std::string EStopControllerBehavior::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 42 of file EStopControllerBehavior.h.
Referenced by getDescription().
| virtual std::string EStopControllerBehavior::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 47 of file EStopControllerBehavior.h.
Member Data Documentation
EStopControllerBehavior * EStopControllerBehavior::theOne = NULL [static] |
Points to the one EStopControllerBehavior object that the input command stream is talking to.
A kludge. Dunno how you're gonna make sure you're not using this uninitialized.
Definition at line 19 of file EStopControllerBehavior.h.
Referenced by callback(), EStopControllerBehavior(), and ~EStopControllerBehavior().
The documentation for this class was generated from the following files:
