PilotNode Class Reference
Creates a PilotRequest pilotreq that the user can modify in their doStart() function, then executes the request when doStart() returns. More...
#include <PilotNode.h>
Detailed Description
Creates a PilotRequest pilotreq that the user can modify in their doStart() function, then executes the request when doStart() returns.
Definition at line 11 of file PilotNode.h.
Public Member Functions | |
| PilotNode (PilotTypes::RequestType_t requestType=PilotTypes::noRequest) | |
| Constructor. | |
| PilotNode (std::string const &name, PilotTypes::RequestType_t requestType=PilotTypes::noRequest) | |
| 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 Pilot, and posts a failure event. | |
Public Attributes | |
| PilotRequest | pilotreq |
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 Pilot. | |
Constructor & Destructor Documentation
| PilotNode::PilotNode | ( | PilotTypes::RequestType_t | requestType = PilotTypes::noRequest |
) |
Constructor.
Definition at line 14 of file PilotNode.h.
| PilotNode::PilotNode | ( | std::string const & | name, | |
| PilotTypes::RequestType_t | requestType = PilotTypes::noRequest | |||
| ) |
Constructor.
Definition at line 18 of file PilotNode.h.
Member Function Documentation
| void PilotNode::cancelThisRequest | ( | ) | [virtual] |
If called inside doStart, prevents request from being passed to Pilot, and posts a failure event.
Definition at line 39 of file PilotNode.cc.
Referenced by Grasper::DoBodyApproach3::doStart(), Grasper::DoBodyApproach2::doStart(), and Grasper::DoBodyApproach::doStart().
| void PilotNode::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 35 of file PilotNode.cc.
| void PilotNode::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 18 of file PilotNode.cc.
| void PilotNode::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.
Reimplemented in WalkForward, WalkSideways, and Turn.
Definition at line 10 of file PilotNode.cc.
| void PilotNode::stop | ( | ) | [virtual] |
Transitions should call this when leaving the state, so it can disable its transitions.
Reimplemented from StateNode.
Definition at line 28 of file PilotNode.cc.
Member Data Documentation
bool PilotNode::cancelFlag [protected] |
If set true in doStart, request will not be submitted to the Pilot.
Definition at line 33 of file PilotNode.h.
Referenced by cancelThisRequest(), postStart(), and preStart().
Definition at line 26 of file PilotNode.h.
Referenced by KoduInterpreter::MotionActionRunner::ExecuteMotionAction::ExecuteDriverMotion::doStart(), KoduInterpreter::MotionActionRunner::ExecuteMotionAction::ExecuteSimpleMotion::ExecuteSimpleWalk::doStart(), KoduInterpreter::MotionActionRunner::ExecuteMotionAction::ExecuteSimpleMotion::ExecuteSimpleTurn::doStart(), KoduInterpreter::MotionActionRunner::ExecuteMotionAction::ExecuteGoToShapeRequest::doStart(), KoduInterpreter::GiveActionRunner::Backup::doStart(), KoduInterpreter::GrabActionRunner::ExecuteGrabAction::PrepareForAnotherGrasp::RepositionBody::doStart(), KoduInterpreter::GrabActionRunner::PrepareBody::ReverseBody::doStart(), KoduInterpreter::GrabActionRunner::PrepareBody::FaceObject::doStart(), KoduInterpreter::DropActionRunner::ExecuteDrop::LocalizeAgent::doStart(), KoduInterpreter::DropActionRunner::ExecuteDrop::ReverseBody::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::PrepareForAnotherGrasp::RepositionBody::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::PrepareForItemRecovery::FaceTarget::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::PrepareForItemRecovery::Reverse::doStart(), KoduInterpreter::PerceptualMultiplexor::PilotTaskRunner::ExecutePilotTask::doStart(), Grasper::DoWithdraw::doStart(), Grasper::DoBodyTransport::doStart(), Grasper::DoBodyApproach3::doStart(), Grasper::DoBodyApproach2::doStart(), Grasper::DoBodyApproach::doStart(), postStart(), preStart(), Turn::preStart(), WalkSideways::preStart(), and WalkForward::preStart().
The documentation for this class was generated from the following files:
