diff --git a/docs/conf.py b/docs/conf.py index b72e4f1..1df22af 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,7 @@ author = 'Real-Time Innovations, Inc.' # The full version, including alpha/beta/rc tags -version = '1.2.0' +version = '1.2.2' release = '1.2.2' master_doc = 'index' diff --git a/docs/configuration.rst b/docs/configuration.rst index 3fec80d..c0ee079 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -13,7 +13,7 @@ that includes the definition of domains, *DomainParticipants*, *Topics*, *Connector* uses the XML schema defined by RTI's `XML-Based Application Creation feature -`__. +`__. .. hint:: The *Connext DDS* C, C++, Java and .NET APIs can also load the same XML files @@ -77,11 +77,11 @@ and ``shapesize``: Types are associated with *Topics*, as explained in the next section, :ref:`Domain Library`. .. hint:: - You can define your types in IDL and convert them to XML with `rtiddsgen `__. + You can define your types in IDL and convert them to XML with `rtiddsgen `__. For example: ``rtiddsgen -convertToXml MyTypes.idl`` For more information about defining types, see -`Creating User Data Types with XML `__ +`Creating User Data Types with XML `__ in the *RTI Connext DDS Core Libraries User's Manual*. For more information about accessing data samples, see :ref:`Accessing the data`. @@ -91,10 +91,10 @@ Domain library A domain library is a collection of domains. A domain specifies: - * A `domain id `__. + * A `domain id `__. * A set of registered types (from a subset of the types in ````). A registered type can have a local name. - * A set of `topics `__, + * A set of `topics `__, which are used by *DataReaders* and *DataWriters*. .. code-block:: xml @@ -108,7 +108,7 @@ A domain library is a collection of domains. A domain specifies: For more information about the format of a domain library, see -`XML-Based Application Creation: Domain Library `__. +`XML-Based Application Creation: Domain Library `__. Participant library ~~~~~~~~~~~~~~~~~~~ @@ -142,12 +142,12 @@ an :class:`Input`, as described in :ref:`Reading data (Input)`. For more information about the format of a participant library, see `XML-Based Application Creation: Participant Library -`__. +`__. Quality of service ~~~~~~~~~~~~~~~~~~ -All DDS entities have an associated `quality of service (QoS) `__. +All DDS entities have an associated `quality of service (QoS) `__. There are several ways to configure it. You can define a QoS profile and make it the default. The following example @@ -234,12 +234,12 @@ profile is equivalent to *MyQosProfile* above: You can read more in the *RTI Connext DDS Core Libraries User's Manual*, `Configuring QoS with XML -`__. +`__. Logging ^^^^^^^ -Logging can be configured as explained in `Configuring Logging via XML `__. +Logging can be configured as explained in `Configuring Logging via XML `__. For example, to increase the logging verbosity from the default (ERROR) to WARNING, define a ``qos_profile`` with the attribute diff --git a/docs/connector.rst b/docs/connector.rst index 1369e60..9a0ba37 100644 --- a/docs/connector.rst +++ b/docs/connector.rst @@ -22,7 +22,7 @@ To create a new :class:`Connector`, pass an XML file and a configuration name: connector = rti.Connector("MyParticipantLibrary::MyParticipant", "ShapeExample.xml"); The XML file defines your types, QoS profiles, and DDS Entities. *Connector* -uses the XML schema of `RTI's XML-Based Application Creation `__. +uses the XML schema of `RTI's XML-Based Application Creation `__. The previous code loads the ```` named *MyParticipant* in the ```` named *MyParticipantLibrary*, which is defined in the @@ -40,7 +40,7 @@ When you create a :class:`Connector`, the DDS *DomainParticipant* that you selec and all its contained entities (*Topics*, *Subscribers*, *DataReaders*, *Publishers*, *DataWriters*) are created. -For more information about the DDS entities, see `Core Concepts `__ +For more information about the DDS entities, see `Core Concepts `__ in the *RTI Connext DDS Core Libraries User's Manual*. .. note:: diff --git a/docs/data.rst b/docs/data.rst index 77a7279..ea45750 100644 --- a/docs/data.rst +++ b/docs/data.rst @@ -432,7 +432,7 @@ To clear a member, set it to ``None`` explicitly:: For more information about optional members in DDS, see -`Optional Members `__ +`Optional Members `__ in the *Extensible Types Guide*. Accessing unions diff --git a/docs/features.rst b/docs/features.rst index 0cfb311..318563b 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -20,7 +20,7 @@ General features * - Feature - Level of support - Notes - * - `Quality of Service (QoS) `__ + * - `Quality of Service (QoS) `__ - Partial - Most QoS policies are supported because they can be configured in XML, but those that are designed to be mutable can't be changed in *Connector*. QoS policies that require @@ -50,19 +50,19 @@ General features order to enable an `Input` only when :meth:`Connector.get_input` is called. * Property - Properties can be set in XML, but they can't be looked up in *Connector* - `Topic Qos `__ is not supported in *Connector*. Use DataReader QoS and DataWriter QoS directly. - * - `Entity Statuses `__ + `Topic Qos `__ is not supported in *Connector*. Use DataReader QoS and DataWriter QoS directly. + * - `Entity Statuses `__ - Partial - Only :meth:`Input.wait` (data available), :meth:`Input.wait_for_publications`, and :meth:`Output.wait_for_subscriptions` are supported. - * - `Managing Data Instances `__ + * - `Managing Data Instances `__ - Partial - On an ``Output``, it is possible to dispose or unregister an instance (see :meth:`Output.write`). Instances are automatically registered when first written. On an ``Input`` the instance state can be obtained, alongside the key fields of a disposed instance (see :ref:`Accessing key values of disposed samples`). Instance handles are not exposed. - * - `Application Acknowledgment `__ + * - `Application Acknowledgment `__ - Partial - *DDS_APPLICATION_AUTO_ACKNOWLEDGMENT_MODE* is supported. If enabled, when a call to :meth:`Input.take` or :meth:`Input.read` is followed by another call, the second one automatically acknowledges the samples read in the first one. *DDS_APPLICATION_EXPLICIT_ACKNOWLEDGMENT_MODE* is not supported. - * - `Request-Reply `__ + * - `Request-Reply `__ - Partial - The correlation between two samples can be established at the application level: @@ -70,21 +70,21 @@ General features * The *Replier* application receives the *request* sample, obtains the ``identity`` (A), from ":attr:`SampleIterator.info` and writes a new sample with ``related_sample_identity=A`` (the *reply* sample) * The *Requester* application receives the *reply* sample, and correlates the ``related_sample_identity`` from :attr:`SampleIterator.info` with the ``identity`` it used in the first step. - * - `Topic Queries `__ + * - `Topic Queries `__ - Partial - ``Input`` doesn't have the API to create a *TopicQuery*, but in the configuration file a *data_writer* can enable support for *TopicQuery* so other *Connext DDS Subscribers* can query the *Connector Publisher*. - * - `Zero Copy Transfer Over Shared Memory `__ + * - `Zero Copy Transfer Over Shared Memory `__ - Not supported - Only available in C and C++. - * - `Built-in Topics `__ + * - `Built-in Topics `__ - Not supported - API not available. - * - `Transport Plugins `__ + * - `Transport Plugins `__ - Partial - The built-in transports can be configured in XML. * - Add-on Libraries - (such as `Monitoring `__, - `Security Plugins `__ ) + (such as `Monitoring `__, + `Security Plugins `__ ) - Supported - See :ref:`Loading Connext DDS Add-On Libraries`. @@ -98,19 +98,19 @@ Features related to sending data * - Feature - Level of support - Notes - * - `Waiting for Acknowledgments `__ + * - `Waiting for Acknowledgments `__ - Supported - See :meth:`Output.wait`. - * - `Coherent Sets `__ + * - `Coherent Sets `__ - Not supported - API not available. - * - `Flow Controllers `__ + * - `Flow Controllers `__ - Partial - Most functionality is available via XML QoS configuration. - * - `Asserting Liveliness Manually `__ + * - `Asserting Liveliness Manually `__ - Not supported - API not available. - * - `Collaborative DataWriters `__ + * - `Collaborative DataWriters `__ - Limited - The virtual GUID can be set per writer in XML, but not per sample. @@ -124,19 +124,19 @@ Features related to receiving data * - Feature - Level of support - Notes - * - `Content-Filtered Topics `__ + * - `Content-Filtered Topics `__ - Partial - - `Configurable in XML `__ but it can't be modified after creation - * - `Sample Info `__ + - `Configurable in XML `__ but it can't be modified after creation + * - `Sample Info `__ - Partial - See :attr:`SampleIterator.info` - * - `Query Conditions `__ + * - `Query Conditions `__ - Not supported - API not available - * - `Group-Ordered Access `__ + * - `Group-Ordered Access `__ - Not supported - API not available - * - `Waiting for Historical Data `__ + * - `Waiting for Historical Data `__ - Not supported - API not available @@ -150,17 +150,17 @@ Features related to the type system * - Feature - Level of support - Notes - * - `DDS type system `__ + * - `DDS type system `__ - Supported - *Connector* can use any DDS type. Types are defined in XML. - * - `Type extensibility `__ + * - `Type extensibility `__ - Supported - *Connector* supports type extensibility, including mutable types in the XML definition of types. It also supports type-consistency enforcement and sample-assignability enforcement; these checks are performed by the *RTI Connext DDS* Core. - * - `Optional members `__ + * - `Optional members `__ - Supported - See :ref:`Accessing optional members`. - * - `Default values `__ + * - `Default values `__ - Supported - For example, to declare a default value for a member:: @@ -174,7 +174,7 @@ Features related to the type system ``Input`` from a *Publisher* whose type is compatible, but doesn't have the field *my_int*, the value you receive will be 20. - * - `Unbounded data `__ + * - `Unbounded data `__ - Supported - To declare an unbounded sequence or string, set its max length to *-1*:: @@ -221,7 +221,7 @@ Features related to the type system - * - `FlatData Language Binding `__ + * - `FlatData Language Binding `__ - Not supported - However, an ``Input`` can receive data published by other *Connext DDS* applications that use FlatData. @@ -230,8 +230,8 @@ Loading Connext DDS Add-On Libraries *Connector* supports features that require the loading of additional *Connext DDS* libraries, such as -`Monitoring `__ -and `Security Plugins `__. +`Monitoring `__ +and `Security Plugins `__. The Monitoring and Security plugins are configured in XML, as described in the previous links. diff --git a/docs/index.rst b/docs/index.rst index 3ad2e7f..eada869 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,5 +50,5 @@ Table of Contents * :ref:`search` To learn more about *RTI Connext DDS*, see the -`RTI Connext DDS Getting Started Guide `__. +`RTI Connext DDS Getting Started Guide `__. More documentation is available in the `RTI Community Portal `__. \ No newline at end of file diff --git a/docs/input.rst b/docs/input.rst index 721369d..f1d3301 100644 --- a/docs/input.rst +++ b/docs/input.rst @@ -131,7 +131,7 @@ See :meth:`SampleIterator.info` for the list of available meta-data fields. *Connext DDS* can produce samples with invalid data, which contain meta-data only. For more information about this, see `Valid Data Flag -`__ +`__ in the *RTI Connext DDS Core Libraries User's Manual*. These samples indicate a change in the instance state. Samples with invalid data still provide the following information: