TrackNode Class Reference
Creates a LookoutTrackRequest trackreq that the user can modify in their doStart() function, then has the Lookout execute the request when doStart() returns. More...
#include <TrackNode.h>
Detailed Description
Creates a LookoutTrackRequest trackreq that the user can modify in their doStart() function, then has the Lookout execute the request when doStart() returns.
Definition at line 10 of file TrackNode.h.
Public Member Functions | |
| TrackNode () | |
| Constructor. | |
| TrackNode (std::string const &name) | |
| Constructor. | |
| virtual void | stop () |
| Transitions should call this when leaving the state, so it can disable its transitions. | |
| virtual void | cancelThisRequest () |
| If called inside doStart, prevents request from being passed to Track, and posts a failure event. | |
Public Attributes | |
| LookoutTrackRequest | trackreq |
Protected Member Functions | |
| virtual void | preStart () |
| Called by start() before the doStart(), allows superclasses to do some initialization startup preceeding subclass customization. | |
| 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 | |
| bool | cancelFlag |
| If set true in doStart, request will not be submitted to the Track. | |
Constructor & Destructor Documentation
| TrackNode::TrackNode | ( | ) |
Constructor.
Definition at line 13 of file TrackNode.h.
| TrackNode::TrackNode | ( | std::string const & | name | ) |
Constructor.
Definition at line 17 of file TrackNode.h.
Member Function Documentation
| void TrackNode::cancelThisRequest | ( | ) | [virtual] |
If called inside doStart, prevents request from being passed to Track, and posts a failure event.
Definition at line 38 of file TrackNode.cc.
| void TrackNode::doEvent | ( | ) | [protected, 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 34 of file TrackNode.cc.
| void TrackNode::postStart | ( | ) | [protected, 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 17 of file TrackNode.cc.
| void TrackNode::preStart | ( | ) | [protected, virtual] |
Called by start() before the doStart(), allows superclasses to do some initialization startup preceeding subclass customization.
For robustness to future change, subclasses should be sure to call the superclass implementation.
Reimplemented from BehaviorBase.
Definition at line 9 of file TrackNode.cc.
| void TrackNode::stop | ( | ) | [virtual] |
Transitions should call this when leaving the state, so it can disable its transitions.
Reimplemented from StateNode.
Definition at line 27 of file TrackNode.cc.
Member Data Documentation
bool TrackNode::cancelFlag [protected] |
If set true in doStart, request will not be submitted to the Track.
Definition at line 32 of file TrackNode.h.
Referenced by cancelThisRequest(), postStart(), and preStart().
Definition at line 25 of file TrackNode.h.
Referenced by postStart(), and preStart().
The documentation for this class was generated from the following files:
