Skip to content

Commit

Permalink
Refs #21590: Apply rev suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: JesusPoderoso <[email protected]>
  • Loading branch information
JesusPoderoso committed Sep 9, 2024
1 parent ec94cf3 commit 11280c4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
22 changes: 11 additions & 11 deletions docs/rst/enhancements/fastdds3/fastdds3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
Support for Fast DDS 3.0
========================

Vulcanexus now includes support for the new `Fast DDS major version 3 <https://fast-dds.docs.eprosima.com/en/latest/notes/notes.html>`, the latest version of the Data Distribution Service (DDS) implementation from eProsima.
Fast DDS 3.0.0 introduces a range of improvements that align with Vulcanexus's mission to provide seamless and efficient middleware solutions for robotics, automotive, aerospace, and other high-demand industries.
Vulcanexus now includes support for the new `Fast DDS major version 3 <https://fast-dds.docs.eprosima.com/en/v3.0.0/notes/notes.html>`, the latest version of the Data Distribution Service (DDS) implementation from eProsima.
Fast DDS *v3.0.0* introduces a range of improvements that align with Vulcanexus's mission to provide seamless and efficient middleware solutions for robotics, automotive, aerospace, and other high-demand industries.

Most relevant features
^^^^^^^^^^^^^^^^^^^^^^

Fast DDS *3.0.0* comes with significant changes and improvements, such as:
Fast DDS *v3.0.0* comes with significant changes and improvements, such as:

* Dynamic Language Binding API according to OMG XTypes v1.3 specification.
* RTPS layer APIs refactor.
* Extended XML configurations (e.g FlowControllers).
* Improvements on creation of RTPS messages.
* Public API and namespace update.
* Project renamed to `fastdds`.
* Project renamed to ``fastdds``.
* Refactored examples.
* Removed deprecated fastrtps-related api.
* Removed deprecated fastrtps-related API.
* Further improvements can be found in `Fast DDS v3.0.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v3.0.0>`.

Implications
Expand All @@ -28,11 +28,11 @@ The following considerations have to be taken into account when using Vulcanexus

* Communicating Vulcanexus with Fast DDS native applications:

* Update Fast DDS version to 3.0.0 or higher.
* Update Fast DDS version to *v3.0.0* or higher.
You can refer to our `Migration guide <https://github.com/eProsima/Fast-DDS/blob/master/UPGRADING.md>` for more detailed information.
* When generating types, the minimum required version of ``Fast DDS-Gen`` is ``v4.0.0``.
If this version is used, the extensibility must be explicitly marked as ``@extensibility(FINAL)`` in idl structs.
However, starting from ``Fast DDS-Gen v4.0.1``, it can be left unspecified, as it will default to ``@final``.
Please, refer to `Fast DDS data types extensibility <https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/dataTypes/dataTypes.html#extensibility>`_ for further information about type extensibility.
* When generating types, the minimum required version of Fast DDS-Gen is *v4.0.0*.
If this version is used, the extensibility must be explicitly marked as ``@extensibility(FINAL)`` in idl structs.
However, starting from Fast DDS-Gen *v4.0.1*, it can be left unspecified, as it will default to ``@extensibility(FINAL)``.
Please, refer to `Fast DDS data types extensibility <https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/dataTypes/dataTypes.html#extensibility>`__ for further information about type extensibility.

* QoS settings for `Data Representation <https://fast-dds.docs.eprosima.com/en/latest/fastdds/dds_layer/core/policy/xtypesExtensions.html#datarepresentationqospolicy>` has to be set to `XCDR_DATA_REPRESENTATION`.
* QoS settings for `Data Representation <https://fast-dds.docs.eprosima.com/en/latest/fastdds/dds_layer/core/policy/xtypesExtensions.html#datarepresentationqospolicy>`__ has to be set to ``XCDR_DATA_REPRESENTATION``.
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ The `HelloWorld.idl`, and its ``msg`` equivalent is as follows:

.. important::

If generating the type for a Fast DDS native application with ``Fast DDS-Gen v4.0.0`` (the minimum required for Fast DDS *v3.0.0*), the extensibility must be explicitly marked as ``@extensibility(FINAL)`` in idl structs.
Starting from ``Fast DDS-Gen v4.0.1``, it can be left unspecified, as it defaults to ``@final``.
Please, refer to `Fast DDS data types extensibility <https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/dataTypes/dataTypes.html#extensibility>`_ for further information about type extensibility.
If generating the type for a Fast DDS native application with Fast DDS-Gen *v4.0.0* (the minimum required for Fast DDS *v3.0.0*), the extensibility must be explicitly marked as ``@extensibility(FINAL)`` in idl structs.
Starting from Fast DDS-Gen *v4.0.1*, it can be left unspecified, as it defaults to ``@extensibility(FINAL)``.
Please, refer to `Fast DDS data types extensibility <https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/dataTypes/dataTypes.html#extensibility>`__ for further information about type extensibility.

.. tabs::

Expand Down Expand Up @@ -222,9 +222,9 @@ In particular, the type generation related code is:

.. important::

If generating the type for a Fast DDS native application with ``Fast DDS-Gen v4.0.0`` (the minimum required for Fast DDS *v3.0.0*), the extensibility must be explicitly marked as ``@extensibility(FINAL)`` in idl structs.
Starting from ``Fast DDS-Gen v4.0.1``, it can be left unspecified, as it defaults to ``@final``.
Please, refer to `Fast DDS data types extensibility <https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/dataTypes/dataTypes.html#extensibility>`_ for further information about type extensibility.
If generating the type for a Fast DDS native application with Fast DDS-Gen *v4.0.0* (the minimum required for Fast DDS *v3.0.0*), the extensibility must be explicitly marked as ``@extensibility(FINAL)`` in idl structs.
Starting from Fast DDS-Gen *v4.0.1*, it can be left unspecified, as it defaults to ``@extensibility(FINAL)``.
Please, refer to `Fast DDS data types extensibility <https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/dataTypes/dataTypes.html#extensibility>`__ for further information about type extensibility.

The call to *Fast DDS-Gen* within ``add_custom_command`` will generate the type support in the `fastdds_app` directory, leaving the file names in a convenient ``GENERATED_TYPE_SUPPORT_FILES`` CMake variable that is later used to add the source files to the executable.
It is important to note the *Fast DDS-Gen* is called with the `-typeros2` flag, so it generates ROS 2 compatible type names.
Expand Down

0 comments on commit 11280c4

Please sign in to comment.