Skip to content

Commit

Permalink
CON-285 merge docs and setup.py info back to master. (#160)
Browse files Browse the repository at this point in the history 

* CON-92, CON-200 merge to 1.1.1 (#85)

* CON-92: Added the ability to obtain current version of Connector (#80)

* CON-92: Added the ability to obtain current version of Connector

3 static methods have been added to Connector
 - version
   - Provides the current version of Connector
 - native_library_version
   - Provides the current version of native libraries being used by Connector
 - native_library_build_string
   - Provides the build ID of the native libraries being used by Connector

* CON-92: Made the _from_native method static

* CON-92: Fixed docs

* CON-92: Changed output

Now a single function that provides a string conatining the API version +
core versions.
For example:
RTI Connector for Python, version 1.1.0
NDDSCORE_BUILD_6.1.0_20210531T122009Z_RTI_UNKNOWN
NDDSC_BUILD_6.1.0_20210531T122009Z_RTI_UNKNOWN
RTICONNECTOR_BUILD_6.1.0_20210531T122009Z_RTI_UNKNOWN

* CON-92: Renamed version to get_version

* CON-92: Remove ConnectorVersion from docs

Co-authored-by: Sam Raeburn <sam@rti.com>
(cherry picked from commit 00164ce)

* CON-200: Fix double free segfault (#79)

* CON-200: Fix double free segfault

* Update test/python/test_rticonnextdds_connector.py

Co-authored-by: Alex Campos <alejandro@rti.com>

Co-authored-by: Sam Raeburn <sam@rti.com>
Co-authored-by: Alex Campos <alejandro@rti.com>
(cherry picked from commit 9ffde89)

* Feature/con 191 (#83) (#86)

* CON-191: Added tests for 64-bit int conversions

* CON-191: Added docs

* CON-191: writer's edits to doc changes (py)

* CON-191: Updated tests and docs to reflect new behaviour

I noticed in the native libraries that we weren't being consistent with
the limits. Sometimes we were not checking for v < -LUA_MAX_INT, and sometimes
we were not being consistent with the use of > vs >=.
I have rectified this, the supported behaviour is as follows:

When setting via set_number, we allow |v| < 2^53.
When getting via get_number, we allow |v| <= 2^53.

The reason for the discrepancy between the set and get, is that
when we have a value in set_number, it has already been cast to a double,
so although 2^53 is perfectly representable, we do not know if the original
value was larger (e.g., 2^53 + 1 would appear as 2^53).

Also extended tests to ensure that all of the various supported ways
of setting / getting 64-bit values work as expected:
- allow setting large values via __setitem__ (string or number),
  set_string, set_dictionary
- allow getting large values via __getitem__ (returned as float or int
  depending on size), get_string, get_dictionary

* CON-191: Completed tests + docs

Co-authored-by: Sam Raeburn <sam@rti.com>
Co-authored-by: rkorte <rkorte@rti.com>
(cherry picked from commit 62a573c)

* CON-92: Handle case in obtaining version where Connector was git cloned (#87) (#88)

(cherry picked from commit 6a0ff37)

* PLATFORMS-2289. Adding macOS 11 to Connector PY release notes.

* HMAINT-235: Handle case where build ID contains 4 digits (#96) (#97)

(cherry picked from commit d7935e2)

* #fix HMAINT-202 -- update libraries for 1.2.0, set version for test.py (#100)

* HMAINT-202 -- correct rc1 version string (#103)

* HMAINT-202 -- set version to rc2 for testing (#107)

* CON-252: updating links from current to 6.1.1, py

* CORE-11993: canonical url added for python connector

* CON-251: connector py release notes for 6.1.1/1.2.0

* CON-251: 1.2.0 doc changes

- Move warning from 64-bit number section to release notes
- Add link to get_version API

* CON-251: added missing release note and fixed canonical formatting error

* CON-253: Document bug in numpy on aarch64 (#113) (#114)

(cherry picked from commit 77399ad)

* CON-234: fixing link to Python API reference

* CON-234: changed python api link to go to github

* HMAINT-202 -- set version string to 1.2.0 (#118)

* CON-251: applying PAM updates to supported platforms

* CON-251. Corrected the Jira # mentioned for CON-200 in what's fixed. Updated Supported Platforms to match JS release notes.

* CON-251. Corrected wording of what's tested.

* #fix HMAINT-202 -- new connector libraries for python, base on DDS 6.1.1 (20211203) (#121)

Co-authored-by: Bob Garrow <bgarrow@rti.com>

* #fix HMAINT-202 -- corrected library git references for py, base on DDS 6.1.1 (20211203) (#122)

* #fix HMAINT-202 -- clean out old libraries for py. (#123)

* CON-257: adding Lua vulnerability assessment to Connector 1.2.0 doc

* CON-257: updating vulnerability assessment section for python

* CON-257: updated release notes and copyright

* #fix HMAINT-202 -- new connector libraries for python, base on DDS 6.1.1 (20220309, bkprt) (#129)

* #fix HMAINT-202 -- final version string 1.2.0 (#132)

* CON-276: Updated loading of redist + commit of submodule (#144) (#146)

(cherry picked from commit a0e4f41)

* Feature/con 272 276 support (#148)

* CON-276: Updated documentation for supported Windows (#147)

* CON-276: Updated documentation for supported Windows

* CON-276: Fix notes

* CON-276: Updated PAM

(cherry picked from commit 0cbb5e1)

* Merge pull request #140 from rticommunity/doc/PY-44-readme

PY-44: adding deprecation notice to connector-py README files only
(cherry picked from commit ddafab4)
(cherry picked from commit 1be36f4)

* CON-276 CON-272: Cherry-picked changes to docs

* CON-276: Fix release notes

Co-authored-by: rkorte <36715349+rkorte@users.noreply.github.com>

* CON-280-support, change version number to 1.2.2 in support/connector/1.2.0 (#150)

* #fix CON-280-support, change version number to 1.2.2

* #fix CON-280-support, add rc suffix to version string ...

Co-authored-by: Bob Garrow <bgarrow@rti.com>

* CON-278 -- rc2 with libraries from 20221028 (#154)

Co-authored-by: Bob Garrow <bgarrow@rti.com>

* HMAINT-747: updating 1.2.0 version to 1.2.2 and 6.1.1 URLs to 6.1.2

* #fix CON-279 -- rc3 for new 20221111 libs ... (#157)

Co-authored-by: Bob Garrow <bgarrow@rti.com>

* CON-278 -- final version string for 1.2.2 (#159)

Co-authored-by: Bob Garrow <bgarrow@rti.com>

Co-authored-by: Sam <raeburnsamuel@gmail.com>
Co-authored-by: adelleolson <adelle@rti.com>
Co-authored-by: rkorte <rkorte@rti.com>
Co-authored-by: rkorte <36715349+rkorte@users.noreply.github.com>
Co-authored-by: Bob Garrow <bgarrow@rti.com>
  • Loading branch information
@alvinkrebs @samuelraeburn
@adelleolson @rkorte
6 people authored Dec 15, 2022
1 parent ddafab4 commit 0b713f0
Show file tree
Hide file tree
Showing 12 changed files with 103 additions and 78 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
author = 'Real-Time Innovations, Inc.'

# The full version, including alpha/beta/rc tags
version = '1.2.0'
release = '1.2.0'
version = '1.2.2'
release = '1.2.2'

master_doc = 'index'

Expand Down
20 changes: 10 additions & 10 deletions docs/configuration.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>`__.

.. hint::
The *Connext DDS* C, C++, Java and .NET APIs can also load the same XML files
Expand Down Expand Up @@ -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 <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/code_generator/users_manual/index.htm>`__.
You can define your types in IDL and convert them to XML with `rtiddsgen <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/code_generator/users_manual/index.htm>`__.
For example: ``rtiddsgen -convertToXml MyTypes.idl``

For more information about defining types, see
`Creating User Data Types with XML <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Creating_User_Data_Types_with_Extensible.htm>`__
`Creating User Data Types with XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Creating_User_Data_Types_with_Extensible.htm>`__
in the *RTI Connext DDS Core Libraries User's Manual*.

For more information about accessing data samples, see :ref:`Accessing the data`.
Expand All @@ -91,10 +91,10 @@ Domain library

A domain library is a collection of domains. A domain specifies:

* A `domain id <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/ChoosingDomainID.htm>`__.
* A `domain id <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/ChoosingDomainID.htm>`__.
* A set of registered types (from a subset of the types in ``<types>``).
A registered type can have a local name.
* A set of `topics <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/WorkingWithTopics.htm>`__,
* A set of `topics <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/WorkingWithTopics.htm>`__,
which are used by *DataReaders* and *DataWriters*.

.. code-block:: xml
Expand All @@ -108,7 +108,7 @@ A domain library is a collection of domains. A domain specifies:
</domain_library>
For more information about the format of a domain library, see
`XML-Based Application Creation: Domain Library <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/DomainLibrary.htm>`__.
`XML-Based Application Creation: Domain Library <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/DomainLibrary.htm>`__.

Participant library
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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
<https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/ParticipantLibrary.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/ParticipantLibrary.htm>`__.

Quality of service
~~~~~~~~~~~~~~~~~~

All DDS entities have an associated `quality of service (QoS) <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/QosPolicies.htm>`__.
All DDS entities have an associated `quality of service (QoS) <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/QosPolicies.htm>`__.
There are several ways to configure it.

You can define a QoS profile and make it the default. The following example
Expand Down Expand Up @@ -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
<https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/XMLConfiguration.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/XMLConfiguration.htm>`__.

Logging
^^^^^^^

Logging can be configured as explained in `Configuring Logging via XML <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Configuring_Logging_via_XML1.htm>`__.
Logging can be configured as explained in `Configuring Logging via XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Configuring_Logging_via_XML1.htm>`__.

For example, to increase the logging verbosity from the default (ERROR) to
WARNING, define a ``qos_profile`` with the attribute
Expand Down
4 changes: 2 additions & 2 deletions docs/connector.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.
uses the XML schema of `RTI's XML-Based Application Creation <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.

The previous code loads the ``<domain_participant>`` named *MyParticipant* in
the ``<domain_participant_library>`` named *MyParticipantLibrary*, which is defined in the
Expand All @@ -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 <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/PartCoreConcepts.htm>`__
For more information about the DDS entities, see `Core Concepts <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/PartCoreConcepts.htm>`__
in the *RTI Connext DDS Core Libraries User's Manual*.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion docs/data.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ To clear a member, set it to ``None`` explicitly::


For more information about optional members in DDS, see
`Optional Members <https://community.rti.com/static/documentation/connext-dds/6.1.1/doc/manuals/connext_dds_professional/extensible_types_guide/index.htm#extensible_types/Optional_Members.htm>`__
`Optional Members <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/extensible_types_guide/index.htm#extensible_types/Optional_Members.htm>`__
in the *Extensible Types Guide*.

Accessing unions
Expand Down
Loading

0 comments on commit 0b713f0

Please sign in to comment.