Document gracefull cancellation API

Signed-off-by: Ramon Wijnands <[email protected]>
ros-navigation · Mar 25, 2024 · 7a2eac8 · 7a2eac8
1 parent c54b2e9
commit 7a2eac8
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst
@@ -73,6 +73,11 @@ The list of methods, their descriptions, and necessity are presented in the tabl
 |                           | robot to drive.  This method passes 2 parameters: reference to the current robot      |                        |
 |                           | pose and its current velocity.                                                        |                        |
 +---------------------------+---------------------------------------------------------------------------------------+------------------------+
+| cancel()                  | Method is called when the controller server receives a cancel request. If this method | No                     |
+|                           | is uninplemented, the controller will immediately stop when receiving a cancel        |                        |
+|                           | request. If this method is implemented, the controller can perform a more graceful    |                        |
+|                           | stop and signal the controller server when it is done.                                |                        |
++---------------------------+---------------------------------------------------------------------------------------+------------------------+
 | setSpeedLimit()           | Method is called when it is required to limit the maximum linear speed of the robot.  | Yes                    |
 |                           | Speed limit could be expressed in absolute value (m/s) or in percentage from maximum  |                        |
 |                           | robot speed. Note that typically, maximum rotational speed is being limited           |                        |