Skip to content

Commit 96e2ddf

Browse files
committed
aligned and renamed section title of Examples to be the same as in section 'Analysis of processing patterns'
1 parent 47f6917 commit 96e2ddf

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

  • _docs/concepts/client_library/execution_management

_docs/concepts/client_library/execution_management/index.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ redirect_from:
3030
* [Configuration phase](#configuration-phase)
3131
* [Running phase](#running-phase)
3232
* [Examples](#examples)
33-
* [Sense-plan-act pipeline](#sense-plan-act-pipeline)
34-
* [Sensor fusion](#sensor-fusion)
35-
* [High priority path](#high-priority-path)
36-
* [Embedded use-case](#embedded-use-case)
37-
* [ROS 2 Executor Workshop Reference System](#ros-2-executor-workshop-reference-system)
33+
* [(1) Sense-plan-act pipeline in robotics](#(1)-sense-plan-act-pipeline-in-robotics)
34+
* [(2) Synchronization of multiple rates](#(2)-synchronization-of-multiple-rates)
35+
* [(3) High-priority processing path](#(3)-high-priority-processing-path)
36+
* [(4) Real-time embedded applications](#(4)-real-time-embedded-applications)
37+
* [(5) ROS 2 Executor Workshop Reference System](#(5)-ros-2-executor-workshop-reference-system)
3838
* [Future work](#future-work)
3939
* [Download](#download)
4040

@@ -402,7 +402,7 @@ Available spin functions are
402402
### Examples
403403
We provide the relevant code snippets how to setup the rclc Executor for the processing patterns as described above.
404404

405-
#### Sense-plan-act pipeline
405+
#### (1) Sense-plan-act pipeline in robotics
406406

407407
In this example we want to realise a sense-plan-act pipeline in a single thread. The trigger condition is demonstrated by activating
408408
the sense-phase when both data for the Laser and IMU are available. Three executors are necessary `exe_sense`, `exe_plan` and `exe_act`. The two sensor acquisition callbacks `sense_Laser` and `sense_IMU` are registered in the Executor `exe_sense`.
@@ -434,7 +434,8 @@ while (true) {
434434
rclc_executor_spin_some(&exe_act);
435435
}
436436
```
437-
#### Sensor fusion
437+
438+
#### (2) Synchronization of multiple rates
438439
439440
The sensor fusion synchronizing the multiple rates with a trigger is shown below.
440441
@@ -476,7 +477,7 @@ rclc_executor_set_trigger(&exe_sense, rclc_executor_trigger_one, &sense_Laser);
476477
// spin
477478
rclc_executor_spin(&exe_sense);
478479
```
479-
#### High priority path
480+
#### (3) High priority processing path
480481
481482
This example shows the sequential processing order to execute the obstacle avoidance `obst_avoid`
482483
after the callbacks of the sense-phase and before the callback of the planning phase `plan`.
@@ -502,7 +503,7 @@ rclc_executor_set_trigger(&exe, rclc_executor_trigger_one, &sense_Laser);
502503
rclc_executor_spin(&exe);
503504
```
504505

505-
#### Embedded use-case
506+
#### (4) Real-time embedded applications
506507

507508
With seqential execution the co-operative scheduling of tasks within a process can be modeled. The trigger condition is used to periodically activate the process which will then execute all callbacks in a pre-defined order. Data will be communicated using the LET-semantics. Every Executor is executed in its own tread, to which an appropriate priority can be assigned.
508509

@@ -564,7 +565,7 @@ rclc_executor_data_comm_semantics(&exe, LET);
564565
rclc_executor_spin(&exe);
565566
```
566567
567-
#### ROS 2 Executor Workshop Reference System
568+
#### (5) ROS 2 Executor Workshop Reference System
568569
The rclc Executor has been presented at the workshop 'ROS 2 Executor: How to make it efficient, real-time and deterministic?' at [ROS World 2021](https://roscon.ros.org/world/2021/) (i.e. the online version of ROSCon)[[S2021](#S2021)]. A [Reference System](https://github.com/ros-realtime/reference-system) for testing and benchmarking ROS Executors has been developed for this workshop. The application of the rclc Executor on the reference system with the trigger condition can be found in the [rclc-executor branch of the Reference System](https://github.com/ros-realtime/reference-system/tree/rclc_executor).
569570
570571
<iframe width="560" height="315" src="https://www.youtube.com/embed/IazrPF3RN1U" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

0 commit comments

Comments
 (0)