zerodds-py 1.0.0-rc.3

PyO3 bindings for the ZeroDDS DCPS API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

API-Referenz
============

Pure-Python-Module
------------------

``zerodds.cdr``
^^^^^^^^^^^^^^^

.. automodule:: zerodds.cdr
   :members:
   :undoc-members:
   :show-inheritance:

``zerodds.idl``
^^^^^^^^^^^^^^^

.. automodule:: zerodds.idl
   :members:
   :undoc-members:
   :show-inheritance:

``zerodds.loader``
^^^^^^^^^^^^^^^^^^

.. automodule:: zerodds.loader
   :members:
   :undoc-members:
   :show-inheritance:

PyO3-Extension-Module ``zerodds._core``
---------------------------------------

The 13 DCPS PyClasses are mocked during the doc build via
``autodoc_mock_imports`` (the extension module ``zerodds._core`` is not
necessarily compiled during the Sphinx doc build). Full method
signatures are produced during the doc build when
``maturin develop --features extension-module`` has been run
beforehand; then ``autodoc_mock_imports`` is overridden.

``DomainParticipantFactory``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: zerodds.DomainParticipantFactory
   :members:
   :undoc-members:
   :show-inheritance:

``DomainParticipant``
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: zerodds.DomainParticipant
   :members:
   :undoc-members:
   :show-inheritance:

``Publisher``
^^^^^^^^^^^^^

.. autoclass:: zerodds.Publisher
   :members:
   :undoc-members:
   :show-inheritance:

``Subscriber``
^^^^^^^^^^^^^^

.. autoclass:: zerodds.Subscriber
   :members:
   :undoc-members:
   :show-inheritance:

``BytesTopic`` / ``BytesWriter`` / ``BytesReader``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: zerodds.BytesTopic
   :members:
   :undoc-members:
.. autoclass:: zerodds.BytesWriter
   :members:
   :undoc-members:
.. autoclass:: zerodds.BytesReader
   :members:
   :undoc-members:

``ShapeTopic`` / ``ShapeWriter`` / ``ShapeReader`` / ``Shape``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: zerodds.ShapeTopic
   :members:
   :undoc-members:
.. autoclass:: zerodds.ShapeWriter
   :members:
   :undoc-members:
.. autoclass:: zerodds.ShapeReader
   :members:
   :undoc-members:
.. autoclass:: zerodds.Shape
   :members:
   :undoc-members:

``GuardCondition`` / ``WaitSet``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: zerodds.GuardCondition
   :members:
   :undoc-members:
.. autoclass:: zerodds.WaitSet
   :members:
   :undoc-members: