diff --git a/code/DDSCodeTester.cpp b/code/DDSCodeTester.cpp index 68067e964..0aa72f205 100644 --- a/code/DDSCodeTester.cpp +++ b/code/DDSCodeTester.cpp @@ -4431,16 +4431,6 @@ void dds_qos_examples() //!-- } - { - //DDS_CHANGE_TYPE_CONSISTENCY_QOS - TypeConsistencyQos consistency_qos; - //You can change the DataRepresentationQosPolicy. For further details see DataRepresentationQosPolicySection section. - consistency_qos.representation.m_value.push_back(DataRepresentationId_t::XCDR2_DATA_REPRESENTATION); - //You can change the TypeConsistencyEnforcementQosPolicy. For further details see TypeConsistencyEnforcementQosPolicy section. - consistency_qos.type_consistency.m_kind = TypeConsistencyKind::ALLOW_TYPE_COERCION; - //!-- - } - // Taken out of the examples to avoid bloating them DomainParticipant* participant = DomainParticipantFactory::get_instance()->create_participant(0, PARTICIPANT_QOS_DEFAULT); diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index 451d7814c..88854fb6e 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -65,6 +65,7 @@ .. |DataReaderQos::resource_limits-api| replace:: :cpp:func:`resource_limits()` .. |DataReaderQos::time_based_filter-api| replace:: :cpp:func:`time_based_filter()` .. |DataReaderQos::type_consistency-api| replace:: :cpp:func:`type_consistency()` +.. |DataReaderQos::representation-api| replace:: :cpp:func:`representation()` .. |DataReaderQos::user_data-api| replace:: :cpp:func:`user_data()` .. |DataReaders-api| replace:: :cpp:class:`DataReaders ` @@ -693,10 +694,6 @@ .. |SharedMemTransportDescriptor::rtps_dump_file-api| replace:: :cpp:func:`rtps_dump_file()` .. |SharedMemTransportDescriptor::dump_thread-api| replace:: :cpp:func:`dump_thread()` -.. |TypeConsistencyQos-api| replace:: :cpp:class:`TypeConsistencyQos` -.. |TypeConsistencyQos::type_consistency-api| replace:: :cpp:member:`type_consistency` -.. |TypeConsistencyQos::representation-api| replace:: :cpp:member:`representation` - .. |WireProtocolConfigQos-api| replace:: :cpp:class:`WireProtocolConfigQos` .. |WireProtocolConfigQos::prefix-api| replace:: :cpp:member:`prefix` .. |WireProtocolConfigQos::participant_id-api| replace:: :cpp:member:`participant_id` diff --git a/docs/03-exports/aliases.include b/docs/03-exports/aliases.include index 219fea8a2..143d45fe3 100644 --- a/docs/03-exports/aliases.include +++ b/docs/03-exports/aliases.include @@ -82,7 +82,6 @@ .. |TransportConfigQos| replace:: :ref:`TransportConfigQos` .. |TransportPriorityQosPolicy| replace:: :ref:`TransportPriorityQosPolicy` .. |TypeConsistencyEnforcementQosPolicy| replace:: :ref:`TypeConsistencyEnforcementQosPolicy` -.. |TypeConsistencyQos| replace:: :ref:`TypeConsistencyQos` .. |TypeInformation| replace:: :ref:`TypeInformation` .. |TypeObject| replace:: :ref:`TypeObject representation` .. |UserDataQosPolicy| replace:: :ref:`UserDataQosPolicy` diff --git a/docs/fastdds/api_reference/dds_pim/subscriber/subscriber.rst b/docs/fastdds/api_reference/dds_pim/subscriber/subscriber.rst index bf604a144..03378078d 100644 --- a/docs/fastdds/api_reference/dds_pim/subscriber/subscriber.rst +++ b/docs/fastdds/api_reference/dds_pim/subscriber/subscriber.rst @@ -16,5 +16,4 @@ Subscriber /fastdds/api_reference/dds_pim/subscriber/subscriber_class.rst /fastdds/api_reference/dds_pim/subscriber/subscriberlistener.rst /fastdds/api_reference/dds_pim/subscriber/subscriberqos.rst - /fastdds/api_reference/dds_pim/subscriber/typeconsistencyqos.rst /fastdds/api_reference/dds_pim/subscriber/viewstatekind.rst diff --git a/docs/fastdds/api_reference/dds_pim/subscriber/typeconsistencyqos.rst b/docs/fastdds/api_reference/dds_pim/subscriber/typeconsistencyqos.rst deleted file mode 100644 index b19571009..000000000 --- a/docs/fastdds/api_reference/dds_pim/subscriber/typeconsistencyqos.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _api_pim_typeconsistencyqos: - -.. rst-class:: api-ref - -TypeConsistencyQos ------------------- - -.. doxygenclass:: eprosima::fastdds::dds::TypeConsistencyQos - :project: FastDDS - :members: diff --git a/docs/fastdds/api_reference/spelling_wordlist.txt b/docs/fastdds/api_reference/spelling_wordlist.txt index fc16cfa82..7c94e704f 100644 --- a/docs/fastdds/api_reference/spelling_wordlist.txt +++ b/docs/fastdds/api_reference/spelling_wordlist.txt @@ -271,7 +271,6 @@ TopicListener TransportDescriptor TransportPriorityQosPolicy TypeConsistencyEnforcementQosPolicy -TypeConsistencyQos typedef typeid TypeIdentfierWithSizePubSubType diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst index 377ec6c59..cf9d9041c 100644 --- a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst +++ b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst @@ -1071,51 +1071,6 @@ XML transports configuration by selecting one of the available builtin transports options. See :ref:`rtps_layer_builtin_transports` or |DomainParticipantQoS::setup_transports-api|. -.. _typeconsistencyqos: - -TypeConsistencyQos -^^^^^^^^^^^^^^^^^^ - -This QoS Policy allows the configuration of the :ref:`XTypes extension QoS` on the |DataReader|. -See |TypeConsistencyQos-api|. - -List of QoS Policy data members: - -+-------------------------------------------------------------------------+--------------------------------------------+ -| Data Member Name | Type | -+=========================================================================+============================================+ -| |TypeConsistencyQos::type_consistency-api| | :ref:`typeconsistencyenforcementqospolicy` | -+-------------------------------------------------------------------------+--------------------------------------------+ -| |TypeConsistencyQos::representation-api| | :ref:`datarepresentationqospolicy` | -+-------------------------------------------------------------------------+--------------------------------------------+ - -* |TypeConsistencyQos::type_consistency-api|: - It states the rules for the data types compatibility. - See :ref:`typeconsistencyenforcementqospolicy` for further details. -* |TypeConsistencyQos::representation-api|: - It specifies the data representations valid for the entities. - See :ref:`datarepresentationqospolicy` for further details. - -.. note:: - This QoS Policy concerns to DataReader entities. - :raw-html:`
` - It cannot be changed on enabled entities. - -Example -""""""" - -C++ -*** -.. literalinclude:: ../../../../../code/DDSCodeTester.cpp - :language: c++ - :dedent: 8 - :start-after: //DDS_CHANGE_TYPE_CONSISTENCY_QOS - :end-before: //! - -XML -*** -This QoS Policy cannot be configured using XML for the moment. - .. _wireprotocolconfigqos: WireProtocolConfigQos diff --git a/docs/fastdds/dds_layer/core/policy/xtypesExtensions.rst b/docs/fastdds/dds_layer/core/policy/xtypesExtensions.rst index 42d1ac5eb..4ebd6c8f6 100644 --- a/docs/fastdds/dds_layer/core/policy/xtypesExtensions.rst +++ b/docs/fastdds/dds_layer/core/policy/xtypesExtensions.rst @@ -1,5 +1,6 @@ .. include:: ../../../../03-exports/aliases.include .. include:: ../../../../03-exports/aliases-api.include +.. include:: ../../../../03-exports/roles.include .. role:: raw-html(raw) :format: html @@ -31,11 +32,21 @@ See |DataRepresentationQosPolicy-api|. List of QoS Policy data members: -+-----------------------------------------------------------+------------------------------------------+---------------+ -| Data Member Name | Type | Default Value | -+===========================================================+==========================================+===============+ -| |DataRepresentationQosPolicy::m_value-api| | std::vector<:ref:`datarepresentationid`> | Empty vector | -+-----------------------------------------------------------+------------------------------------------+---------------+ +.. list-table:: + :header-rows: 1 + + * - Data Member Name + - Type + - Default Value + - DataReader default value + - DataWriter default value + - Topic default value + * - |DataRepresentationQosPolicy::m_value-api| + - std::vector<:ref:`datarepresentationid`> + - Empty vector + - [|XCDR_DATA_REPRESENTATION-api|, |br| |XCDR2_DATA_REPRESENTATION-api|] + - [|XCDR2_DATA_REPRESENTATION-api|] + - [|XCDR_DATA_REPRESENTATION-api|] .. note:: This QoS Policy concerns to Topic, DataReader and DataWriter entities. diff --git a/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst b/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst index af71945c4..e378c30a5 100644 --- a/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst +++ b/docs/fastdds/dds_layer/subscriber/dataReader/dataReader.rst @@ -72,7 +72,9 @@ Internally it contains the following |QosPolicy-api| objects: +-----------------------------------------------+---------------------------------------------+----------+ | |RTPSreliablereaderqos| | |DataReaderQos::reliable_reader_qos-api| | Yes (*) | +-----------------------------------------------+---------------------------------------------+----------+ -| |typeconsistencyqos| | |DataReaderQos::type_consistency-api| | Yes | +| |typeconsistencyenforcementqospolicy| | |DataReaderQos::type_consistency-api| | Yes | ++-----------------------------------------------+---------------------------------------------+----------+ +| |datarepresentationqospolicy| | |DataReaderQos::representation-api| | Yes | +-----------------------------------------------+---------------------------------------------+----------+ | |datasharingqospolicy| | |DataReaderQos::data_sharing-api| | No | +-----------------------------------------------+---------------------------------------------+----------+ diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst index f04c1d429..b2de10b62 100644 --- a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst +++ b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst @@ -15,5 +15,4 @@ Subscriber /fastdds/python_api_reference/dds_pim/subscriber/subscriber_class.rst /fastdds/python_api_reference/dds_pim/subscriber/subscriberlistener.rst /fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst - /fastdds/python_api_reference/dds_pim/subscriber/typeconsistencyqos.rst /fastdds/python_api_reference/dds_pim/subscriber/viewstatekind.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/typeconsistencyqos.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/typeconsistencyqos.rst deleted file mode 100644 index 085a218da..000000000 --- a/docs/fastdds/python_api_reference/dds_pim/subscriber/typeconsistencyqos.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _python_api_pim_typeconsistencyqos: - -.. rst-class:: api-ref - -TypeConsistencyQos ------------------- - -.. autoclass:: fastdds.TypeConsistencyQos