MapBuilderNode Class Reference
Creates a MapBuilderRequest mapreq that the user can modify in their doStart() function, then executes the request when doStart() returns. More...
#include <MapBuilderNode.h>
Detailed Description
Creates a MapBuilderRequest mapreq that the user can modify in their doStart() function, then executes the request when doStart() returns.
Definition at line 12 of file MapBuilderNode.h.
Public Member Functions | |
| MapBuilderNode (MapBuilderRequest::MapBuilderRequestType_t requestType=MapBuilderRequest::cameraMap) | |
| Constructor. | |
| MapBuilderNode (std::string const name, MapBuilderRequest::MapBuilderRequestType_t requestType=MapBuilderRequest::cameraMap) | |
| Constructor. | |
| 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. | |
| virtual void | cancelThisRequest () |
| If called inside doStart, prevents request from being passed to MapBuilder, and posts a failure event. | |
Protected Attributes | |
| MapBuilderRequest | mapreq |
| bool | cancelFlag |
| If set true in doStart, request will not be submitted to the MapBuilder. | |
Constructor & Destructor Documentation
| MapBuilderNode::MapBuilderNode | ( | MapBuilderRequest::MapBuilderRequestType_t | requestType = MapBuilderRequest::cameraMap |
) |
Constructor.
Definition at line 15 of file MapBuilderNode.h.
| MapBuilderNode::MapBuilderNode | ( | std::string const | name, | |
| MapBuilderRequest::MapBuilderRequestType_t | requestType = MapBuilderRequest::cameraMap | |||
| ) |
Constructor.
Definition at line 19 of file MapBuilderNode.h.
Member Function Documentation
| virtual void MapBuilderNode::cancelThisRequest | ( | ) | [virtual] |
If called inside doStart, prevents request from being passed to MapBuilder, and posts a failure event.
Definition at line 41 of file MapBuilderNode.h.
Referenced by DualCoding::Pilot::LocalizationUtility::TakeInitialPicture::doStart().
| virtual void MapBuilderNode::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 36 of file MapBuilderNode.h.
| virtual void MapBuilderNode::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 28 of file MapBuilderNode.h.
| virtual void MapBuilderNode::preStart | ( | ) | [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 23 of file MapBuilderNode.h.
Member Data Documentation
bool MapBuilderNode::cancelFlag [protected] |
If set true in doStart, request will not be submitted to the MapBuilder.
Definition at line 48 of file MapBuilderNode.h.
Referenced by cancelThisRequest(), postStart(), and preStart().
MapBuilderRequest MapBuilderNode::mapreq [protected] |
Definition at line 47 of file MapBuilderNode.h.
Referenced by DualCoding::Pilot::VisualSearchMachine::Search::doStart(), DualCoding::Pilot::LookForTarget::doStart(), DualCoding::Pilot::LookForObject::doStart(), DualCoding::Pilot::LocalizationUtility::TakeNextPicture::doStart(), DualCoding::Pilot::LocalizationUtility::TakeInitialPicture::doStart(), KoduInterpreter::MotionActionRunner::ExecuteMotionAction::ExecuteSimpleMotion::FindMotionTarget::doStart(), KoduInterpreter::ReceiveActionRunner::FindObject::doStart(), KoduInterpreter::ReceiveActionRunner::ReceiveActionTurnAndGet::FindObject::doStart(), KoduInterpreter::GrabActionRunner::ExecuteGrabAction::PrepareForAnotherGrasp::FindObjectAgain::doStart(), KoduInterpreter::GrabActionRunner::ExecuteGrabAction::PrepareForAnotherGrasp::LookAroundForObject::doStart(), KoduInterpreter::GrabActionRunner::ExecuteGrabAction::VerifyObjectWasGrabbed::LookAtTheGripper::doStart(), KoduInterpreter::DropActionRunner::ExecuteDrop::RepositionReleasedObject::LookForObjectAgain::doStart(), KoduInterpreter::DropActionRunner::ExecuteDrop::LookAtObjectAprilTag::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::PrepareForAnotherGrasp::FindObjectAgain::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::PrepareForAnotherGrasp::LookForTag::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::VerifyObjectWasGrabbed::LookAtTheGripper::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::PrepareForItemRecovery::LocateLostObject::doStart(), KoduInterpreter::PerceptualMultiplexor::MapBuilderTaskRunner::ExecuteMapBuilderTask::doStart(), KoduInterpreter::InitializeAgent::LookAround::doStart(), Grasper::Verify::GetCross::doStart(), Grasper::Verify::GetDomino::doStart(), Grasper::Verify::GetAprilTag::doStart(), Grasper::FindObj::doStart(), and postStart().
The documentation for this class was generated from the following file:
