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::PathFollower2dConsumer Class Reference
[PathFollower2d]
Consumer of path updates.
More...
Inherited by goalplanner::ProgressMonitor, orcaprobefactory::PathFollower2dProbe, and orcaqgui2d::PathUpdateConsumer.
Public Member Functions | |
| void | setWaypointIndex (int index) |
| void | setActivationTime (Time absoluteTime, double relativeTime) |
| void | setData (PathFollower2dData data) |
| void | setEnabledState (bool enabledState) |
| When the follower's enabled-state changes, it tells all subscribers about it. | |
Detailed Description
Consumer of path updates.Member Function Documentation
| void orca::PathFollower2dConsumer::setWaypointIndex | ( | int | index | ) |
Used by the follower to broadcast changes without transmitting the entire path. Given that the follower is loaded up with a list of n waypoints, the follower will call 'setWaypointIndex' with the index of the waypoint it is _actively_ seeking.
- Normal waypoint indices are in the range [0,n-1]
- The special index '-1' means 'I just completed my path and became inactive'.
- Suppose the follower has been loaded with a path but is inactive. On activation, it will call 'setWaypointIndex(0)'.
| void orca::PathFollower2dConsumer::setActivationTime | ( | Time | absoluteTime, | |
| double | relativeTime | |||
| ) |
Once the follower starts following a path it notifies consumers of the activation time. It provides:
- the absolute time (useful if clocks of provider and consumers are synchronized).
- the relative time (how many seconds ago the follower started following).
| void orca::PathFollower2dConsumer::setData | ( | PathFollower2dData | data | ) |
When the follower is loaded with a new path, it transmits that path to all subscribers.
The documentation for this class was generated from the following file:
- pathfollower2d.ice
