GrasperNode Class Reference
Creates a GrasperRequest graspreq that the user can modify in their doStart() function, then executes the request when doStart() returns. More...
#include <GrasperNode.h>
Detailed Description
Creates a GrasperRequest graspreq that the user can modify in their doStart() function, then executes the request when doStart() returns.
Definition at line 10 of file GrasperNode.h.
Public Member Functions | |
| GrasperNode (GrasperRequest::GrasperRequestType_t requestType) | |
| Constructor. | |
| GrasperNode (std::string const name, GrasperRequest::GrasperRequestType_t requestType) | |
| Constructor. | |
| virtual void | cancelThisRequest () |
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 | |
| GrasperRequest | graspreq |
| bool | cancelFlag |
Constructor & Destructor Documentation
| GrasperNode::GrasperNode | ( | GrasperRequest::GrasperRequestType_t | requestType | ) |
Constructor.
Definition at line 13 of file GrasperNode.h.
| GrasperNode::GrasperNode | ( | std::string const | name, | |
| GrasperRequest::GrasperRequestType_t | requestType | |||
| ) |
Constructor.
Definition at line 17 of file GrasperNode.h.
Member Function Documentation
| void GrasperNode::cancelThisRequest | ( | ) | [virtual] |
Definition at line 46 of file GrasperNode.cc.
| void GrasperNode::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 24 of file GrasperNode.cc.
| void GrasperNode::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 14 of file GrasperNode.cc.
| void GrasperNode::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 GrasperNode.cc.
Member Data Documentation
bool GrasperNode::cancelFlag [protected] |
Definition at line 28 of file GrasperNode.h.
Referenced by cancelThisRequest(), postStart(), and preStart().
GrasperRequest GrasperNode::graspreq [protected] |
Definition at line 27 of file GrasperNode.h.
Referenced by KoduInterpreter::GrabActionRunner::ExecuteGrabAction::GrabObject::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::ObjectManipRecovery::RetrieveLostObject::doStart(), and postStart().
The documentation for this class was generated from the following files:
