GrasperTrans Class Reference
Causes a transition if a GrasperEvent from grasperEGID occurs, and checks for a specific error value if one is supplied. More...
#include <GrasperTrans.h>
Detailed Description
Causes a transition if a GrasperEvent from grasperEGID occurs, and checks for a specific error value if one is supplied.
This allows a GrasperNode to signal a transition to another state in a clean symbolic way. Only the transition itself needs to know the address of the destination node. The GrasperEvent will be supplied to the destination node's doStart() method.
Definition at line 16 of file GrasperTrans.h.
Public Member Functions | |
| GrasperTrans (StateNode *destination) | |
| Constructor. | |
| GrasperTrans (StateNode *destination, GrasperRequest::GrasperErrorType_t value) | |
| Constructor. | |
| GrasperTrans (const std::string &name, StateNode *destination) | |
| Constructor. | |
| GrasperTrans (const std::string &name, StateNode *destination, GrasperRequest::GrasperErrorType_t value) | |
| Constructor. | |
| virtual void | postStart () |
| Called by start() after the doStart(), allows superclasses to complete initialization. | |
| virtual void | doEvent () |
| Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event. | |
| GrasperTrans (const GrasperTrans &src) | |
| Copy constructor required in case we're storing a pointer. | |
| GrasperTrans & | operator= (const GrasperTrans &src) |
| Assignment operator required in case we're storing a pointer. | |
Protected Attributes | |
| GrasperRequest::GrasperErrorType_t | errorCode |
| value to compare against | |
| bool | valueSupplied |
| true if a value was supplied in the constructor | |
Constructor & Destructor Documentation
| GrasperTrans::GrasperTrans | ( | StateNode * | destination | ) |
Constructor.
Definition at line 19 of file GrasperTrans.h.
| GrasperTrans::GrasperTrans | ( | StateNode * | destination, | |
| GrasperRequest::GrasperErrorType_t | value | |||
| ) |
Constructor.
Definition at line 24 of file GrasperTrans.h.
| GrasperTrans::GrasperTrans | ( | const std::string & | name, | |
| StateNode * | destination | |||
| ) |
Constructor.
Definition at line 29 of file GrasperTrans.h.
| GrasperTrans::GrasperTrans | ( | const std::string & | name, | |
| StateNode * | destination, | |||
| GrasperRequest::GrasperErrorType_t | value | |||
| ) |
Constructor.
Definition at line 34 of file GrasperTrans.h.
| GrasperTrans::GrasperTrans | ( | const GrasperTrans & | src | ) |
Copy constructor required in case we're storing a pointer.
Definition at line 58 of file GrasperTrans.h.
Member Function Documentation
| virtual void GrasperTrans::doEvent | ( | ) | [virtual] |
Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event.
Default implementation watches for 'private' text message events (those forwarded by a BehaviorSwitchControl from ControllerGUI input) and will publically rebroadcast them. The idea is that your own processEvent gets first dibs, but if the behavior doesn't handle the text message, it will be handed off for others.
Reimplemented from BehaviorBase.
Definition at line 44 of file GrasperTrans.h.
| GrasperTrans& GrasperTrans::operator= | ( | const GrasperTrans & | src | ) |
Assignment operator required in case we're storing a pointer.
Definition at line 61 of file GrasperTrans.h.
| virtual void GrasperTrans::postStart | ( | ) | [virtual] |
Called by start() after the doStart(), allows superclasses to complete initialization.
For robustness to future change, subclasses should be sure to call the superclass implementation.
Reimplemented from BehaviorBase.
Definition at line 38 of file GrasperTrans.h.
Member Data Documentation
value to compare against
Definition at line 68 of file GrasperTrans.h.
Referenced by doEvent(), and operator=().
bool GrasperTrans::valueSupplied [protected] |
true if a value was supplied in the constructor
Definition at line 69 of file GrasperTrans.h.
Referenced by doEvent(), and operator=().
The documentation for this class was generated from the following file:
