Allow users to configure the executor for executables in `demo_nodes_…

…cpp` (#666) * Allow users to build demo executables to run with a different executor Signed-off-by: Yadunund <[email protected]> Signed-off-by: Yadu <[email protected]> Co-authored-by: Michael Carroll <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
ros2 · Feb 9, 2024 · 93030b5 · 93030b5
1 parent 5b81fcc
commit 93030b5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/demo_nodes_cpp/CMakeLists.txt b/demo_nodes_cpp/CMakeLists.txt
@@ -92,9 +92,12 @@ function(create_demo_library plugin executable)
     ARCHIVE DESTINATION lib
     LIBRARY DESTINATION lib
     RUNTIME DESTINATION bin)
+  set(DEMO_EXECUTOR "rclcpp::executors::SingleThreadedExecutor" CACHE STRING "The executor for the demo nodes")
+  message(STATUS "Setting executor of ${executable} to ${DEMO_EXECUTOR}")
   rclcpp_components_register_node(${library}
     PLUGIN ${plugin}
-    EXECUTABLE ${executable})
+    EXECUTABLE ${executable}
+    EXECUTOR ${DEMO_EXECUTOR})
 endfunction()
 
 # Timers

diff --git a/demo_nodes_cpp/README.md b/demo_nodes_cpp/README.md
@@ -37,6 +37,14 @@ Run the command below to compile the `demo_nodes_cpp` ROS 2 package:
 colcon build --packages-up-to demo_nodes_cpp
 ```
 
+**Note**: By default, the demo executables will spin up the [SingleThreaded executor](https://docs.ros.org/en/rolling/Concepts/Intermediate/About-Executors.html#executors) if run in separate processes, i.e., not composed in the same component container.
+To configure the demo executables to run with a different executor, build the package with the custom `DEMO_EXECUTOR` flag set to the fully qualified name of the executor.
+For example, to run with the experimental `EventsExecutor`,
+
+```bash
+colcon build --packages-select demo_nodes_cpp --cmake-args -DDEMO_EXECUTOR:STRING=rclcpp::experimental::executors::EventsExecutor
+```
+
 ## **Run**
 
 ### Basic Talker & Listener