Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Extra Arguments for Component Manager. #4904

Merged
merged 3 commits into from
Jan 15, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 45 additions & 2 deletions source/Tutorials/Intermediate/Composition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,51 @@ Passing additional arguments into components
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``ros2 component load`` command-line supports passing particular options to the component manager for use when constructing the node.
As of now, the only command-line option that is supported is to instantiate a node using intra-process communication.
This functionality can be used as follows:

As of now, the following extra arguments are supported.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved

.. list-table:: Extra Arguments for Component Manager
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
:widths: 15 15 15 15
:header-rows: 1

* - Argument
- Type
- Default
- Description
* - ``forward_global_arguments``
- Boolean
- True
- Apply global arguments to the component node when loading.
* - ``enable_rosout``
- Boolean
- True
- Enable ``rosout`` topic publisher to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
* - ``use_intra_process_comms``
- Boolean
- False
- Enable intra-process communication to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
* - ``enable_topic_statistics``
- Boolean
- False
- Enable topic statistics publisher to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
* - ``start_parameter_services``
- Boolean
- True
- Enable services to manage parameters to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
* - ``start_parameter_event_publisher``
- Boolean
- True
- Enable parameter event publisher to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
* - ``use_clock_thread``
- Boolean
- True
- Enable a dedicated clock thread to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
* - ``enable_logger_service``
- Boolean
- False
- Enable logger level management service to the component node.
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved

These optional arguments can be used as follow example of ``use_intra_process_comms``:

.. code-block:: bash

Expand Down