PilotTrans Class Reference
Causes a transition if a PilotEvent from pilotEGID occurs, and checks for a specific error value if one is supplied. More...
#include <PilotTrans.h>
Detailed Description
Causes a transition if a PilotEvent from pilotEGID occurs, and checks for a specific error value if one is supplied.
This allows a PilotNode 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 PilotEvent will be supplied to the destination node's doStart() method.
Definition at line 17 of file PilotTrans.h.
Public Member Functions | |
| PilotTrans (StateNode *destination) | |
| Constructor. | |
| PilotTrans (StateNode *destination, DualCoding::PilotTypes::ErrorType_t value) | |
| Constructor. | |
| PilotTrans (const std::string &name, StateNode *destination) | |
| Constructor. | |
| PilotTrans (const std::string &name, StateNode *destination, DualCoding::PilotTypes::ErrorType_t value) | |
| Constructor. | |
| PilotTrans (const PilotTrans &src) | |
| Copy 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. | |
Protected Attributes | |
| DualCoding::PilotTypes::ErrorType_t | errorType |
| value to compare against | |
| bool | valueSupplied |
| true if a value was supplied in the constructor | |
| PilotEvent | savedEvent |
Private Member Functions | |
| PilotTrans & | operator= (const PilotTrans &src) |
| don't call this | |
Constructor & Destructor Documentation
| PilotTrans::PilotTrans | ( | StateNode * | destination | ) |
Constructor.
Definition at line 20 of file PilotTrans.h.
| PilotTrans::PilotTrans | ( | StateNode * | destination, | |
| DualCoding::PilotTypes::ErrorType_t | value | |||
| ) |
Constructor.
Definition at line 24 of file PilotTrans.h.
| PilotTrans::PilotTrans | ( | const std::string & | name, | |
| StateNode * | destination | |||
| ) |
Constructor.
Definition at line 28 of file PilotTrans.h.
| PilotTrans::PilotTrans | ( | const std::string & | name, | |
| StateNode * | destination, | |||
| DualCoding::PilotTypes::ErrorType_t | value | |||
| ) |
Constructor.
Definition at line 32 of file PilotTrans.h.
| PilotTrans::PilotTrans | ( | const PilotTrans & | src | ) |
Copy constructor.
Definition at line 41 of file PilotTrans.cc.
Member Function Documentation
| void PilotTrans::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 11 of file PilotTrans.cc.
| PilotTrans& PilotTrans::operator= | ( | const PilotTrans & | src | ) | [private] |
don't call this
| void PilotTrans::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 5 of file PilotTrans.cc.
Member Data Documentation
DualCoding::PilotTypes::ErrorType_t PilotTrans::errorType [protected] |
PilotEvent PilotTrans::savedEvent [protected] |
Definition at line 44 of file PilotTrans.h.
Referenced by doEvent().
bool PilotTrans::valueSupplied [protected] |
true if a value was supplied in the constructor
Definition at line 43 of file PilotTrans.h.
Referenced by doEvent().
The documentation for this class was generated from the following files:
