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 () |
| virtual void | postStart () |
| virtual void | doEvent () |
| 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.
| virtual void MapBuilderNode::doEvent | ( | ) | [virtual] |
Definition at line 36 of file MapBuilderNode.h.
| virtual void MapBuilderNode::postStart | ( | ) | [virtual] |
Definition at line 28 of file MapBuilderNode.h.
| virtual void MapBuilderNode::preStart | ( | ) | [virtual] |
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 postStart().
The documentation for this class was generated from the following file:
