TextMsgTrans Class Reference
#include <TextMsgTrans.h>
Inheritance diagram for TextMsgTrans:
Detailed Description
Fires when a matching string is received.
Definition at line 9 of file TextMsgTrans.h.
Public Member Functions | |
| TextMsgTrans (StateNode *destination, const std::string &trigger) | |
| default constructor, use type name as instance name | |
| virtual void | DoStart () |
| Just like a behavior, called when it's time to start doing your thing. | |
| virtual void | processEvent (const EventBase &event) |
| By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing. | |
| virtual void | DoStop () |
| Just like a behavior, called when it's time to stop doing your thing. | |
| 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 Member Functions | |
| TextMsgTrans (const std::string &class_name, const std::string &instance_name, StateNode *destination, const std::string &trigger) | |
| constructor for subclasses (which would need to provide a different class name) | |
Protected Attributes | |
| std::string | msg |
| the trigger to match messages against | |
Private Member Functions | |
| TextMsgTrans (const TextMsgTrans &) | |
| don't call (copy constructor) | |
| TextMsgTrans & | operator= (const TextMsgTrans &) |
| don't call (assignment operator) | |
Member Function Documentation
| static std::string TextMsgTrans::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 51 of file TextMsgTrans.h.
Referenced by getDescription().
| virtual std::string TextMsgTrans::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 52 of file TextMsgTrans.h.
The documentation for this class was generated from the following file:
