Explain necessity to do get_qos before set_qos in DomainParticipant (#…

…430) * Refs #16328: Explain necesity to do get_qos before set_qos in DomainParticipant Signed-off-by: Mikel Rico <[email protected]> * Refs #16328: Update explanation Signed-off-by: Mikel Rico <[email protected]> * Update docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst Signed-off-by: Mikel Rico <[email protected]> Co-authored-by: Eduardo Ponz Segrelles <[email protected]> Signed-off-by: Mikel Rico <[email protected]> Signed-off-by: Mikel Rico <[email protected]> Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
eProsima · Dec 13, 2022 · 8e27ef4 · 8e27ef4
1 parent 2e61ed0
commit 8e27ef4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include
@@ -137,7 +137,7 @@
 .. |DomainParticipant::set_default_publisher_qos-api| replace:: :cpp:func:`set_default_publisher_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_publisher_qos>`
 .. |DomainParticipant::set_default_subscriber_qos-api| replace:: :cpp:func:`set_default_subscriber_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_subscriber_qos>`
 .. |DomainParticipant::set_default_topic_qos-api| replace:: :cpp:func:`set_default_topic_qos()<eprosima::fastdds::dds::DomainParticipant::set_default_topic_qos>`
-.. |DomainParticipant::get_qos-api| replace:: :cpp:func:`get_qos()<eprosima::fastdds::dds::DomainParticipant::get_qos>`
+.. |DomainParticipant::get_qos-api| replace:: :cpp:func:`DomainParticipant::get_qos()<eprosima::fastdds::dds::DomainParticipant::get_qos>`
 .. |DomainParticipant::get_publisher_qos_from_profile| replace:: :cpp:func:`get_publisher_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_publisher_qos_from_profile>`
 .. |DomainParticipant::get_subscriber_qos_from_profile| replace:: :cpp:func:`get_subscriber_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_subscriber_qos_from_profile>`
 .. |DomainParticipant::get_topic_qos_from_profile| replace:: :cpp:func:`get_topic_qos_from_profile()<eprosima::fastdds::dds::DomainParticipant::get_topic_qos_from_profile>`

diff --git a/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst b/docs/fastdds/dds_layer/domain/domainParticipant/domainParticipant.rst
@@ -52,6 +52,19 @@ Internally it contains the following |QosPolicy-api| objects:
     |BuiltinAttributes::discovery_config-api| within |WireProtocolConfigQos::builtin-api| (see
     :ref:`DS_modify_server_list`).
 
+
+.. important::
+
+    Upon the call to |DomainParticipantFactory::create_participant-api|, if Fast DDS is compiled with statistics support
+    (enabled by default, see :ref:`cmake_options`), the internal |DomainParticipantQos-api| may differ from the input
+    |DomainParticipantQos-api| (see :ref:`property_policies_statistics`).
+    This entails that applications willing to further modify the |DomainParticipantQos-api| after
+    |DomainParticipant-api| creation should:
+
+         1. Retrieve the internal |DomainParticipantQos-api| by the means of |DomainParticipant::get_qos-api|.
+         2. Perform the desired modifications.
+         3. Update the |DomainParticipantQos-api| by the means of |DomainParticipant::set_qos-api|.
+
 Refer to the detailed description of each QosPolicy class for more information about their usage and
 default values.