Skip to content

Commit

Permalink
Website update
Browse files Browse the repository at this point in the history
Building for cyclonedds master, changed from commit 25bf38ab88e8f56bfde1c12d7ba65de38cb80a18 to 30c079baae76d1bc7d4bdf23dad77fa3e0ee0069. Building for cyclonedds-python master, changed from commit 2b5231f620b9643b6651dc9647eb5dfbbd4fec0b to 53004e7235f40496cdf5e376c91233a8cac1daf0.
  • Loading branch information
Python cyclonedds.io Builder committed Dec 10, 2024
1 parent 88ea881 commit 1bc25f4
Show file tree
Hide file tree
Showing 19 changed files with 395 additions and 284 deletions.
4 changes: 2 additions & 2 deletions database.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"cyclonedds": {
"master_commit": "25bf38ab88e8f56bfde1c12d7ba65de38cb80a18",
"master_commit": "30c079baae76d1bc7d4bdf23dad77fa3e0ee0069",
"tags": [
"0.10.5",
"0.8.2",
Expand Down Expand Up @@ -57,7 +57,7 @@
]
},
"cyclonedds-python": {
"master_commit": "2b5231f620b9643b6651dc9647eb5dfbbd4fec0b",
"master_commit": "53004e7235f40496cdf5e376c91233a8cac1daf0",
"tags": [
"0.0.1rc2",
"0.10.5",
Expand Down
Binary file not shown.
Binary file modified pages/docs/cyclonedds-python/latest/.doctrees/environment.pickle
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h1>Source code for cyclonedds.idl</h1><div class="highlight"><pre>

<span class="kn">from</span> <span class="nn">.types</span> <span class="kn">import</span> <span class="n">ValidUnionHolder</span>
<span class="kn">from</span> <span class="nn">._main</span> <span class="kn">import</span> <span class="n">IdlMeta</span><span class="p">,</span> <span class="n">IdlUnionMeta</span><span class="p">,</span> <span class="n">IdlBitmaskMeta</span><span class="p">,</span> <span class="n">IdlEnumMeta</span>
<span class="kn">from</span> <span class="nn">._support</span> <span class="kn">import</span> <span class="n">Buffer</span><span class="p">,</span> <span class="n">Endianness</span>
<span class="kn">from</span> <span class="nn">._support</span> <span class="kn">import</span> <span class="n">Buffer</span><span class="p">,</span> <span class="n">Endianness</span><span class="p">,</span> <span class="n">SerializeKind</span>


<span class="n">_TIS</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;_TIS&#39;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s1">&#39;IdlStruct&#39;</span><span class="p">)</span>
Expand All @@ -168,6 +168,9 @@ <h1>Source code for cyclonedds.idl</h1><div class="highlight"><pre>
<div class="viewcode-block" id="IdlStruct.serialize"><a class="viewcode-back" href="../../cyclonedds.idl.html#cyclonedds.idl.IdlStruct.serialize">[docs]</a> <span class="k">def</span> <span class="nf">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">buffer</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Buffer</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">endianness</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Endianness</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">use_version_2</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__idl__</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">buffer</span><span class="o">=</span><span class="n">buffer</span><span class="p">,</span> <span class="n">endianness</span><span class="o">=</span><span class="n">endianness</span><span class="p">,</span> <span class="n">use_version_2</span><span class="o">=</span><span class="n">use_version_2</span><span class="p">)</span></div>

<div class="viewcode-block" id="IdlStruct.serialize_key"><a class="viewcode-back" href="../../cyclonedds.idl.html#cyclonedds.idl.IdlStruct.serialize_key">[docs]</a> <span class="k">def</span> <span class="nf">serialize_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endianness</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Endianness</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">use_version_2</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__idl__</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endianness</span><span class="o">=</span><span class="n">endianness</span><span class="p">,</span> <span class="n">use_version_2</span><span class="o">=</span><span class="n">use_version_2</span><span class="p">,</span> <span class="n">serialize_kind</span><span class="o">=</span><span class="n">SerializeKind</span><span class="o">.</span><span class="n">KeyDefinitionOrder</span><span class="p">)</span></div>

<div class="viewcode-block" id="IdlStruct.deserialize"><a class="viewcode-back" href="../../cyclonedds.idl.html#cyclonedds.idl.IdlStruct.deserialize">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">deserialize</span><span class="p">(</span><span class="bp">cls</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">_TIS</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">has_header</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">use_version_2</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">_TIS</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">__idl__</span><span class="o">.</span><span class="n">deserialize</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">has_header</span><span class="o">=</span><span class="n">has_header</span><span class="p">,</span> <span class="n">use_version_2</span><span class="o">=</span><span class="n">use_version_2</span><span class="p">)</span></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ <h1>Source code for cyclonedds.pub</h1><div class="highlight"><pre>
<span class="sd"> timestamp</span>
<span class="sd"> The sample&#39;s source_timestamp (in nanoseconds since the UNIX Epoch)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize_key</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">ser</span><span class="o">.</span><span class="n">ljust</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">ser</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="p">(</span><span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">),</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\0</span><span class="s1">&#39;</span><span class="p">)</span>

<span class="k">if</span> <span class="n">timestamp</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
Expand Down Expand Up @@ -398,7 +398,7 @@ <h1>Source code for cyclonedds.pub</h1><div class="highlight"><pre>
<span class="k">raise</span> <span class="n">DDSException</span><span class="p">(</span><span class="n">ret</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Occurred while disposing in </span><span class="si">{</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>

<div class="viewcode-block" id="DataWriter.register_instance"><a class="viewcode-back" href="../../cyclonedds.pub.html#cyclonedds.pub.DataWriter.register_instance">[docs]</a> <span class="k">def</span> <span class="nf">register_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sample</span><span class="p">:</span> <span class="n">_T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize_key</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">ser</span><span class="o">.</span><span class="n">ljust</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">ser</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="p">(</span><span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">),</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\0</span><span class="s1">&#39;</span><span class="p">)</span>

<span class="n">ret</span> <span class="o">=</span> <span class="n">ddspy_register_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ref</span><span class="p">,</span> <span class="n">ser</span><span class="p">)</span>
Expand All @@ -415,7 +415,7 @@ <h1>Source code for cyclonedds.pub</h1><div class="highlight"><pre>
<span class="sd"> timestamp</span>
<span class="sd"> The timestamp used at registration (in nanoseconds since the UNIX Epoch)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize_key</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">ser</span><span class="o">.</span><span class="n">ljust</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">ser</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="p">(</span><span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">),</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\0</span><span class="s1">&#39;</span><span class="p">)</span>

<span class="k">if</span> <span class="n">timestamp</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
Expand Down Expand Up @@ -466,7 +466,7 @@ <h1>Source code for cyclonedds.pub</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This operation takes a sample and returns an instance handle to be used for subsequent operations.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize_key</span><span class="p">(</span><span class="n">use_version_2</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_use_version_2</span><span class="p">)</span>
<span class="n">ser</span> <span class="o">=</span> <span class="n">ser</span><span class="o">.</span><span class="n">ljust</span><span class="p">((</span><span class="nb">len</span><span class="p">(</span><span class="n">ser</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&amp;</span> <span class="o">~</span><span class="p">(</span><span class="mi">4</span> <span class="o">-</span> <span class="mi">1</span><span class="p">),</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\0</span><span class="s1">&#39;</span><span class="p">)</span>

<span class="n">ret</span> <span class="o">=</span> <span class="n">ddspy_lookup_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ref</span><span class="p">,</span> <span class="n">ser</span><span class="p">)</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ <h1>Source code for cyclonedds.sub</h1><div class="highlight"><pre>
<span class="k">raise</span> <span class="n">DDSException</span><span class="p">(</span><span class="n">ret</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Occured while waiting for historical data in </span><span class="si">{</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>

<div class="viewcode-block" id="DataReader.lookup_instance"><a class="viewcode-back" href="../../cyclonedds.sub.html#cyclonedds.sub.DataReader.lookup_instance">[docs]</a> <span class="k">def</span> <span class="nf">lookup_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sample</span><span class="p">:</span> <span class="n">_T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">ddspy_lookup_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ref</span><span class="p">,</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize</span><span class="p">())</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">ddspy_lookup_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ref</span><span class="p">,</span> <span class="n">sample</span><span class="o">.</span><span class="n">serialize_key</span><span class="p">())</span>
<span class="k">if</span> <span class="n">ret</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DDSException</span><span class="p">(</span><span class="n">ret</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;Occurred while lookup up instance from </span><span class="si">{</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ret</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
Expand Down
Loading

0 comments on commit 1bc25f4

Please sign in to comment.