@@ -11,60 +11,50 @@ class ManualWaypointController : virtual Controller
1111 ManualWaypointController ();
1212 ~ManualWaypointController ();
1313
14- /* *
15- * Clears the list of waypoints to visit.
16- *
17- * NOTE: this will not stop the robot from driving to a waypoint if
18- * it was already driving there before this was called.
19- */
14+
15+ // Clears the list of waypoints to visit.
16+
17+ // NOTE: this will not stop the robot from driving to a waypoint if
18+ // it was already driving there before this was called.
2019 void Reset () override ;
2120
22- /* *
23- * Returns the next waypoint in the list. The result is set up to
24- * be used by DriveController for waypoint navigation.
25- * /
21+
22+ // Returns the next waypoint in the list. The result is set up to
23+ // be used by DriveController for waypoint navigation.
24+ / /
2625 Result DoWork () override ;
2726
28- /* *
29- * True if there are waypoints in the list. False otherwise.
30- */
27+
28+ // True if there are waypoints in the list. False otherwise.
3129 bool HasWork () override ;
32-
33- /* *
34- * Interrupts only if the number of waypoints has changed and is
35- * non-zero.
36- */
30+
31+ // Interrupts only if the number of waypoints has changed and is
32+ // non-zero.
3733 bool ShouldInterrupt () override ;
3834
39- /* *
40- * Tell the controller the current location of the robot.
41- */
35+
36+ // Tell the controller the current location of the robot.
4237 void SetCurrentLocation (Point currentLocation);
4338
44- /* *
45- * Add the provided waypoint to the list of manual waypoints.
46- *
47- * NOTE: Waypoints should have unique ids, it is incumbent on the
48- * caller to ensure this. Providing the same IDs for multiple
49- * waypoints may cause undefined behavior in the GUI. Further more
50- * if the ID is removed using RemoveManualWaypoint() then all
51- * waypoints with that ID may be removed.
52- */
39+ // Add the provided waypoint to the list of manual waypoints.
40+
41+ // NOTE: Waypoints should have unique ids, it is incumbent on the
42+ // caller to ensure this. Providing the same IDs for multiple
43+ // waypoints may cause undefined behavior in the GUI. Further more
44+ // if the ID is removed using RemoveManualWaypoint() then all
45+ // waypoints with that ID may be removed.
5346 void AddManualWaypoint (Point wpt, int id);
5447
55- /* *
56- * Remove the waypoint with the given ID from the list of waypoints
57- * to visit. If no maypoint exists with the given ID, the no action
58- * is taken.
59- */
48+
49+ // Remove the waypoint with the given ID from the list of waypoints
50+ // to visit. If no maypoint exists with the given ID, the no action
51+ // is taken.
6052 void RemoveManualWaypoint (int id);
6153
62- /* *
63- * Get a vector containing all waypoint IDs that have been visited
64- * since this function was last called.
65- *
66- * This should be called regularly to prevent memory leaks.
67- */
54+ // Get a vector containing all waypoint IDs that have been visited
55+ // since this function was last called.
56+
57+ // This should be called regularly to prevent memory leaks.
6858 std::vector<int > ReachedWaypoints ();
6959
7060protected:
@@ -81,4 +71,4 @@ class ManualWaypointController : virtual Controller
8171 const float waypoint_tolerance = 0.15 ;
8272};
8373
84- #endif // MANUALWAYPOINTCONTROLLER_H
74+ #endif // MANUALWAYPOINTCONTROLLER_H
0 commit comments