|
orca-robotics INTRODUCTION Overview Download and Install Quick Start Documentation Publications REPOSITORY Interfaces Components Libraries Utilities Software Map DEVELOPER Tutorials Examples Dev Guide Dashboard Wiki login/pass: orca/orca PEOPLE Contributors Users Project Download Mailing lists
|
orca::PathPlanner2d Class ReferencePlanning a path in 2D.
More...
|
|||||||||||||||||||||||||||||||||||||||||
Public Member Functions | |
| int | setTask (PathPlanner2dTask task) throw ( BusyException, RequiredInterfaceFailedException) |
| PathPlanner2dData | getData ()) |
| Returns the most-recently-computed computed path. | |
| void | subscribe (PathPlanner2dConsumer *subscriber) throw ( SubscriptionFailedException) |
| void | unsubscribe (PathPlanner2dConsumer *subscriber)) |
PathPlanner is an interface that accepts a task consisting of a coarse path with the first entry being the starting waypoint. It serves the computed fine-grained path to the consumer via proxy. "setTask" returns the number of tasks in queue ahead of this new task.
The second method of accessing the computed path is to use the getData method. The third method is via subscribe. These two methods are used when a component wants direct access to the currently computed path rather than a one-shot task-specific result (e.g. a GUI).
| int orca::PathPlanner2d::setTask | ( | PathPlanner2dTask | task | ) | throw ( BusyException, RequiredInterfaceFailedException) |
Set a task. Returns the number of tasks currently in the queue (not including the one which was just set).
| void orca::PathPlanner2d::subscribe | ( | PathPlanner2dConsumer * | subscriber | ) | throw ( SubscriptionFailedException) |
Mimics IceStorm's subscribe(). The implementation may choose to implement the push directly or use IceStorm. This choice is transparent to the subscriber.
| subscriber | The subscriber's proxy. |
| void orca::PathPlanner2d::unsubscribe | ( | PathPlanner2dConsumer * | subscriber | ) |
Unsubscribe the given [subscriber].
| subscriber | The proxy of an existing subscriber. |
Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)
1.4.5