Skip to content

Commit 14ea4a6

Browse files
authored
doc: Added explanation of preceding/following controllers (#2192)
1 parent 944de32 commit 14ea4a6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

controller_manager/doc/controller_chaining.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,12 @@ This means the following:
4848

4949
.. note::
5050

51-
Only the controllers that exposes the reference interfaces are switched to chained mode, when their reference interfaces are used by other controllers. When their reference interfaces are not used by the other controllers, they are switched back to get references from the subscriber.
52-
However, the controllers that exposes the state interfaces are not triggered to chained mode, when their state interfaces are used by other controllers.
51+
Controllers that expose the reference interfaces are switched to chained mode only when their reference interfaces are used by other controllers. When their reference interfaces are not used by other controllers, they are switched back to get references from the subscriber.
52+
However, the controllers that expose the state interfaces are not triggered to chained mode when their state interfaces are used by other controllers.
53+
54+
.. note::
55+
56+
This document uses terms *preceding* and *following* controller. These terms refer to such ordering of controllers that controller A *precedes* controller B if A claims (*connects its output to*) B's reference interfaces (*inputs*). In the example diagram at the beginning of this section, 'diff_drive_controller' *precedes* 'pid left wheel' and 'pid right wheel'. Consequently, 'pid left wheel' and 'pid right wheel' are controllers *following* after 'diff_drive_controller'.
5357

5458
Implementation
5559
--------------

0 commit comments

Comments
 (0)