Feature: Added Documentation in
This commit is contained in:
@@ -139,7 +139,7 @@
|
||||
<div class="type">Package</div>
|
||||
<div class="kind">Package</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol)</div>
|
||||
</li><li id="fn_gen.common">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.common</div>
|
||||
@@ -147,7 +147,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Common functions that are used all over the package</div>
|
||||
</li><li id="fn_gen.dg2052">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052</div>
|
||||
@@ -155,7 +155,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
||||
<div class="summary">The main funciton generator module</div>
|
||||
</li><li id="fn_gen.enums">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums</div>
|
||||
@@ -163,7 +163,7 @@
|
||||
<div class="type">Package</div>
|
||||
<div class="kind">Package</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Some enums that are used within this package</div>
|
||||
</li><li id="fn_gen.enums.comm_method">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.comm<wbr></wbr>_method</div>
|
||||
@@ -171,7 +171,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
||||
<div class="summary">Communication Method Enumeration</div>
|
||||
</li><li id="fn_gen.enums.sweep_signal_type">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_signal<wbr></wbr>_type</div>
|
||||
@@ -179,7 +179,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
||||
<div class="summary">Enumeration representing the different signal types used in a sweep</div>
|
||||
</li><li id="fn_gen.enums.sweep_spacing">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_spacing</div>
|
||||
@@ -187,7 +187,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
||||
<div class="summary">The spacings used for the sweep</div>
|
||||
</li><li id="fn_gen.enums.sweep_trigger_slope">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_slope</div>
|
||||
@@ -195,7 +195,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
||||
<div class="summary">The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></div>
|
||||
</li><li id="fn_gen.enums.sweep_trigger_source">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.sweep<wbr></wbr>_trigger<wbr></wbr>_source</div>
|
||||
@@ -203,7 +203,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
|
||||
<div class="summary">The different sources available to trigger a sweep</div>
|
||||
</li><li id="fn_gen.errors">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors</div>
|
||||
@@ -211,7 +211,7 @@
|
||||
<div class="type">Package</div>
|
||||
<div class="kind">Package</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">A combination of errors used within the package</div>
|
||||
</li><li id="fn_gen.errors.undefined_communication_method_error">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_communication<wbr></wbr>_method<wbr></wbr>_error</div>
|
||||
@@ -219,7 +219,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">An error type used when the communication method is not in the <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> enum</div>
|
||||
</li><li id="fn_gen.errors.undefined_value_error">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_value<wbr></wbr>_error</div>
|
||||
@@ -227,7 +227,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">An error used when the value used is not defined</div>
|
||||
</li><li id="fn_gen.errors.value_out_of_bounds_error">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.value<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_bounds<wbr></wbr>_error</div>
|
||||
@@ -235,7 +235,7 @@
|
||||
<div class="type">Module</div>
|
||||
<div class="kind">Module</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">An error used when the value used is out of bounds for the function</div>
|
||||
</li><li id="fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.errors<wbr></wbr>.undefined<wbr></wbr>_communication<wbr></wbr>_method<wbr></wbr>_error<wbr></wbr>.<wbr></wbr>Undefined<wbr></wbr>Communication<wbr></wbr>Method<wbr></wbr>Error</div>
|
||||
@@ -291,7 +291,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Function</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Checks the whether the given value is within bounds</div>
|
||||
</li><li id="fn_gen.enums.comm_method.CommMethod">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.enums<wbr></wbr>.comm<wbr></wbr>_method<wbr></wbr>.<wbr></wbr>Comm<wbr></wbr>Method</div>
|
||||
@@ -444,30 +444,30 @@
|
||||
<div class="kind">Class</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary">This is an object representing the Rigol DG2052 function generator. This object uses the SCPI protocol for communicating with the Rigol DG2052 function generator.</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.port">
|
||||
</li><li id="fn_gen.dg2052.DG2052.__comm">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.port</div>
|
||||
<div class="url">fn_gen.dg2052.DG2052.html#port</div>
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.__comm</div>
|
||||
<div class="url">fn_gen.dg2052.DG2052.html#__comm</div>
|
||||
<div class="type">Attribute</div>
|
||||
<div class="kind">Instance Variable</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary">The SCPI port describing the device, consists of a communication method and device port followed by the "::INSTR" keyword. communication method: can be either USB or TCPIP (other communication methods are not supported for this device) device port: either COMM4 or /dev/USB0 for USB in windows and posix systems respectively or the IP Address for TCPIP...</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.rm">
|
||||
<div class="privacy">PRIVATE</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.__rm">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.rm</div>
|
||||
<div class="url">fn_gen.dg2052.DG2052.html#rm</div>
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.__rm</div>
|
||||
<div class="url">fn_gen.dg2052.DG2052.html#__rm</div>
|
||||
<div class="type">Attribute</div>
|
||||
<div class="kind">Instance Variable</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary">The resource manager object for pyvisa (for future use)</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.comm">
|
||||
<div class="privacy">PRIVATE</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.__port">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.comm</div>
|
||||
<div class="url">fn_gen.dg2052.DG2052.html#comm</div>
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.__port</div>
|
||||
<div class="url">fn_gen.dg2052.DG2052.html#__port</div>
|
||||
<div class="type">Attribute</div>
|
||||
<div class="kind">Instance Variable</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary">The communication method used (either TCPIP or USB)</div>
|
||||
<div class="privacy">PRIVATE</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.__init__">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.__init__</div>
|
||||
@@ -483,7 +483,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary">shows the identification of the connected instrument</div>
|
||||
<div class="summary">Shows the identification of the connected instrument</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_output">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_output</div>
|
||||
@@ -499,7 +499,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Toggles the corresponding output channel</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.get_output_volt_limits">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_volt<wbr></wbr>_limits</div>
|
||||
@@ -515,7 +515,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the output impedance.</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.get_output_load">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_load</div>
|
||||
@@ -523,7 +523,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the output load.</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.get_output_signal">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_signal</div>
|
||||
@@ -531,7 +531,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the signal type and parameters.</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.get_output_state">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.get<wbr></wbr>_output<wbr></wbr>_state</div>
|
||||
@@ -539,7 +539,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns the output state of the signal</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.is_output_on">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.is<wbr></wbr>_output<wbr></wbr>_on</div>
|
||||
@@ -547,7 +547,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Returns a boolean representing the state of the output</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_dc">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_dc</div>
|
||||
@@ -555,7 +555,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to DC voltage mode</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_sine_wave">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_sine<wbr></wbr>_wave</div>
|
||||
@@ -563,7 +563,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to A Sine Wave</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_frequency">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_frequency</div>
|
||||
@@ -571,7 +571,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the frequency of the set signal</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_square_wave">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_square<wbr></wbr>_wave</div>
|
||||
@@ -579,7 +579,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to A Square Wave</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_ramp">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_ramp</div>
|
||||
@@ -587,7 +587,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the output channel to A Ramp (Triangular) Wave</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.set_sweep">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.set<wbr></wbr>_sweep</div>
|
||||
@@ -595,7 +595,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Sets the parameters of a signal sweep</div>
|
||||
</li><li id="fn_gen.dg2052.DG2052.trigger_sweep">
|
||||
|
||||
<div class="fullName">fn<wbr></wbr>_gen<wbr></wbr>.dg2052<wbr></wbr>.DG2052<wbr></wbr>.trigger<wbr></wbr>_sweep</div>
|
||||
@@ -603,7 +603,7 @@
|
||||
<div class="type">Function</div>
|
||||
<div class="kind">Method</div>
|
||||
<div class="privacy">PUBLIC</div>
|
||||
<div class="summary"><span class="undocumented">Undocumented</span></div>
|
||||
<div class="summary">Triggers a sweep manually (Only works if the sweep was setup with <code>trigger_source</code> as <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#MANUAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.MANUAL">SweepTriggerSource.MANUAL</a></code>)</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -150,7 +150,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -286,7 +286,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>Common functions that are used all over the package</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -297,7 +297,7 @@
|
||||
|
||||
<td>Function</td>
|
||||
<td><code><a href="#check_bounds" class="internal-link" title="fn_gen.common.check_bounds">check<wbr></wbr>_bounds</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>Checks the whether the given value is within bounds</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -328,7 +328,7 @@
|
||||
</div>
|
||||
<div class="docstring functionBody">
|
||||
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>Checks the whether the given value is within bounds</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">bounds:</span><code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a>[<a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code>, <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a>]</code></td><td class="fieldArgDesc">The bounds to check within</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">value:</span><code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code></td><td class="fieldArgDesc">The value to check</td></tr></table></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -342,7 +342,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -286,7 +286,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>The main funciton generator module</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -318,7 +318,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -351,7 +351,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -296,7 +296,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>Communication Method Enumeration</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -328,7 +328,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -326,7 +326,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>Some enums that are used within this package</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -337,27 +337,27 @@
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.enums.comm_method.html" class="internal-link" title="fn_gen.enums.comm_method">comm<wbr></wbr>_method</a></code></td>
|
||||
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
|
||||
<td>Communication Method Enumeration</td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.enums.sweep_signal_type.html" class="internal-link" title="fn_gen.enums.sweep_signal_type">sweep<wbr></wbr>_signal<wbr></wbr>_type</a></code></td>
|
||||
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
|
||||
<td>Enumeration representing the different signal types used in a sweep</td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep<wbr></wbr>_spacing</a></code></td>
|
||||
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
|
||||
<td>The spacings used for the sweep</td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.enums.sweep_trigger_slope.html" class="internal-link" title="fn_gen.enums.sweep_trigger_slope">sweep<wbr></wbr>_trigger<wbr></wbr>_slope</a></code></td>
|
||||
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
|
||||
<td>The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep<wbr></wbr>_trigger<wbr></wbr>_source</a></code></td>
|
||||
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
|
||||
<td>The different sources available to trigger a sweep</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -378,7 +378,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -390,7 +390,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -296,7 +296,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>Enumeration representing the different signal types used in a sweep</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -328,7 +328,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -390,7 +390,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -296,7 +296,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>The spacings used for the sweep</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -328,7 +328,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -351,7 +351,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -296,7 +296,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -328,7 +328,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -390,7 +390,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -296,7 +296,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>The different sources available to trigger a sweep</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -328,7 +328,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -306,7 +306,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>A combination of errors used within the package</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -317,17 +317,17 @@
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.errors.undefined_communication_method_error.html" class="internal-link" title="fn_gen.errors.undefined_communication_method_error">undefined<wbr></wbr>_communication<wbr></wbr>_method<wbr></wbr>_error</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>An error type used when the communication method is not in the <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> enum</td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.errors.undefined_value_error.html" class="internal-link" title="fn_gen.errors.undefined_value_error">undefined<wbr></wbr>_value<wbr></wbr>_error</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>An error used when the value used is not defined</td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.errors.value_out_of_bounds_error.html" class="internal-link" title="fn_gen.errors.value_out_of_bounds_error">value<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_bounds<wbr></wbr>_error</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>An error used when the value used is out of bounds for the function</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -348,7 +348,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -312,7 +312,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -276,7 +276,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>An error type used when the communication method is not in the <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> enum</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -308,7 +308,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -312,7 +312,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -276,7 +276,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>An error used when the value used is not defined</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -308,7 +308,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -312,7 +312,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -276,7 +276,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>An error used when the value used is out of bounds for the function</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -308,7 +308,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -244,7 +244,7 @@
|
||||
</div>
|
||||
|
||||
<div class="moduleDocstring">
|
||||
<div><p class="undocumented">Undocumented</p></div>
|
||||
<div><p>A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol)</p></div>
|
||||
</div>
|
||||
|
||||
<div id="splitTables">
|
||||
@@ -255,22 +255,22 @@
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.common.html" class="internal-link" title="fn_gen.common">common</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>Common functions that are used all over the package</td>
|
||||
</tr><tr class="module">
|
||||
|
||||
<td>Module</td>
|
||||
<td><code><a href="fn_gen.dg2052.html" class="internal-link" title="fn_gen.dg2052">dg2052</a></code></td>
|
||||
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
|
||||
<td>The main funciton generator module</td>
|
||||
</tr><tr class="package">
|
||||
|
||||
<td>Package</td>
|
||||
<td><code><a href="fn_gen.enums.html" class="internal-link" title="fn_gen.enums">enums</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>Some enums that are used within this package</td>
|
||||
</tr><tr class="package">
|
||||
|
||||
<td>Package</td>
|
||||
<td><code><a href="fn_gen.errors.html" class="internal-link" title="fn_gen.errors">errors</a></code></td>
|
||||
<td><span class="undocumented">Undocumented</span></td>
|
||||
<td>A combination of errors used within the package</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -291,7 +291,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -139,7 +139,7 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<ul id="summaryTree"><li><code><a href="index.html" class="internal-link">fn_gen</a></code> - <span class="undocumented">Undocumented</span><ul><li><code><a href="fn_gen.common.html" class="internal-link" title="fn_gen.common">common</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="fn_gen.dg2052.html" class="internal-link" title="fn_gen.dg2052">dg2052</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.html" class="internal-link" title="fn_gen.enums">enums</a></code> - <span class="undocumented">Undocumented</span><ul><li><code><a href="fn_gen.enums.comm_method.html" class="internal-link" title="fn_gen.enums.comm_method">comm_method</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_signal_type.html" class="internal-link" title="fn_gen.enums.sweep_signal_type">sweep_signal_type</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep_spacing</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_trigger_slope.html" class="internal-link" title="fn_gen.enums.sweep_trigger_slope">sweep_trigger_slope</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li></ul></li><li><code><a href="fn_gen.errors.html" class="internal-link" title="fn_gen.errors">errors</a></code> - <span class="undocumented">Undocumented</span><ul><li><code><a href="fn_gen.errors.undefined_communication_method_error.html" class="internal-link" title="fn_gen.errors.undefined_communication_method_error">undefined_communication_method_error</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="fn_gen.errors.undefined_value_error.html" class="internal-link" title="fn_gen.errors.undefined_value_error">undefined_value_error</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="fn_gen.errors.value_out_of_bounds_error.html" class="internal-link" title="fn_gen.errors.value_out_of_bounds_error">value_out_of_bounds_error</a></code> - <span class="undocumented">Undocumented</span></li></ul></li></ul></li></ul>
|
||||
<ul id="summaryTree"><li><code><a href="index.html" class="internal-link">fn_gen</a></code> - A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol)<ul><li><code><a href="fn_gen.common.html" class="internal-link" title="fn_gen.common">common</a></code> - Common functions that are used all over the package</li><li><code><a href="fn_gen.dg2052.html" class="internal-link" title="fn_gen.dg2052">dg2052</a></code> - The main funciton generator module</li><li><code><a href="fn_gen.enums.html" class="internal-link" title="fn_gen.enums">enums</a></code> - Some enums that are used within this package<ul><li><code><a href="fn_gen.enums.comm_method.html" class="internal-link" title="fn_gen.enums.comm_method">comm_method</a></code> - Communication Method Enumeration</li><li><code><a href="fn_gen.enums.sweep_signal_type.html" class="internal-link" title="fn_gen.enums.sweep_signal_type">sweep_signal_type</a></code> - Enumeration representing the different signal types used in a sweep</li><li><code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep_spacing</a></code> - The spacings used for the sweep</li><li><code><a href="fn_gen.enums.sweep_trigger_slope.html" class="internal-link" title="fn_gen.enums.sweep_trigger_slope">sweep_trigger_slope</a></code> - The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></li><li><code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> - The different sources available to trigger a sweep</li></ul></li><li><code><a href="fn_gen.errors.html" class="internal-link" title="fn_gen.errors">errors</a></code> - A combination of errors used within the package<ul><li><code><a href="fn_gen.errors.undefined_communication_method_error.html" class="internal-link" title="fn_gen.errors.undefined_communication_method_error">undefined_communication_method_error</a></code> - An error type used when the communication method is not in the <code><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link" title="fn_gen.enums.comm_method.CommMethod">CommMethod</a></code> enum</li><li><code><a href="fn_gen.errors.undefined_value_error.html" class="internal-link" title="fn_gen.errors.undefined_value_error">undefined_value_error</a></code> - An error used when the value used is not defined</li><li><code><a href="fn_gen.errors.value_out_of_bounds_error.html" class="internal-link" title="fn_gen.errors.value_out_of_bounds_error">value_out_of_bounds_error</a></code> - An error used when the value used is out of bounds for the function</li></ul></li></ul></li></ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -149,7 +149,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
@@ -146,7 +146,7 @@
|
||||
<h2>C</h2>
|
||||
<p class="letterlinks">C - <a href="#D">D</a> - <a href="#E">E</a> - <a href="#F">F</a> - <a href="#G">G</a> - <a href="#I">I</a> - <a href="#L">L</a> - <a href="#M">M</a> - <a href="#N">N</a> - <a href="#P">P</a> - <a href="#R">R</a> - <a href="#S">S</a> - <a href="#T">T</a> - <a href="#U">U</a> - <a href="#V">V</a> - <a href="#W">W</a> - <a href="#_">_</a></p>
|
||||
<ul id="summaryTree">
|
||||
<li>check_bounds - <code data-type="Function"><a href="fn_gen.common.html#check_bounds" class="internal-link">fn_gen.common.check_bounds</a></code></li><li>comm - <code data-type="Instance Variable"><a href="fn_gen.dg2052.DG2052.html#comm" class="internal-link">fn_gen.dg2052.DG2052.comm</a></code></li><li>comm_method - <code data-type="Module"><a href="fn_gen.enums.comm_method.html" class="internal-link">fn_gen.enums.comm_method</a></code></li><li>CommMethod - <code data-type="Class"><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link">fn_gen.enums.comm_method.CommMethod</a></code></li><li>common - <code data-type="Module"><a href="fn_gen.common.html" class="internal-link">fn_gen.common</a></code></li>
|
||||
<li>check_bounds - <code data-type="Function"><a href="fn_gen.common.html#check_bounds" class="internal-link">fn_gen.common.check_bounds</a></code></li><li>comm_method - <code data-type="Module"><a href="fn_gen.enums.comm_method.html" class="internal-link">fn_gen.enums.comm_method</a></code></li><li>CommMethod - <code data-type="Class"><a href="fn_gen.enums.comm_method.CommMethod.html" class="internal-link">fn_gen.enums.comm_method.CommMethod</a></code></li><li>common - <code data-type="Module"><a href="fn_gen.common.html" class="internal-link">fn_gen.common</a></code></li>
|
||||
</ul>
|
||||
|
||||
<a name="D">
|
||||
@@ -227,7 +227,7 @@
|
||||
<h2>P</h2>
|
||||
<p class="letterlinks"><a href="#C">C</a> - <a href="#D">D</a> - <a href="#E">E</a> - <a href="#F">F</a> - <a href="#G">G</a> - <a href="#I">I</a> - <a href="#L">L</a> - <a href="#M">M</a> - <a href="#N">N</a> - P - <a href="#R">R</a> - <a href="#S">S</a> - <a href="#T">T</a> - <a href="#U">U</a> - <a href="#V">V</a> - <a href="#W">W</a> - <a href="#_">_</a></p>
|
||||
<ul id="summaryTree">
|
||||
<li>port - <code data-type="Instance Variable"><a href="fn_gen.dg2052.DG2052.html#port" class="internal-link">fn_gen.dg2052.DG2052.port</a></code></li><li>POSITIVE - <code data-type="Constant"><a href="fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.html#POSITIVE" class="internal-link">fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.POSITIVE</a></code></li>
|
||||
<li>POSITIVE - <code data-type="Constant"><a href="fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.html#POSITIVE" class="internal-link">fn_gen.enums.sweep_trigger_slope.SweepTriggerSlope.POSITIVE</a></code></li>
|
||||
</ul>
|
||||
|
||||
<a name="R">
|
||||
@@ -236,7 +236,7 @@
|
||||
<h2>R</h2>
|
||||
<p class="letterlinks"><a href="#C">C</a> - <a href="#D">D</a> - <a href="#E">E</a> - <a href="#F">F</a> - <a href="#G">G</a> - <a href="#I">I</a> - <a href="#L">L</a> - <a href="#M">M</a> - <a href="#N">N</a> - <a href="#P">P</a> - R - <a href="#S">S</a> - <a href="#T">T</a> - <a href="#U">U</a> - <a href="#V">V</a> - <a href="#W">W</a> - <a href="#_">_</a></p>
|
||||
<ul id="summaryTree">
|
||||
<li>RAMP - <code data-type="Constant"><a href="fn_gen.enums.sweep_signal_type.SweepSignalType.html#RAMP" class="internal-link">fn_gen.enums.sweep_signal_type.SweepSignalType.RAMP</a></code></li><li>rm - <code data-type="Instance Variable"><a href="fn_gen.dg2052.DG2052.html#rm" class="internal-link">fn_gen.dg2052.DG2052.rm</a></code></li>
|
||||
<li>RAMP - <code data-type="Constant"><a href="fn_gen.enums.sweep_signal_type.SweepSignalType.html#RAMP" class="internal-link">fn_gen.enums.sweep_signal_type.SweepSignalType.RAMP</a></code></li>
|
||||
</ul>
|
||||
|
||||
<a name="S">
|
||||
@@ -290,7 +290,7 @@
|
||||
<h2>_</h2>
|
||||
<p class="letterlinks"><a href="#C">C</a> - <a href="#D">D</a> - <a href="#E">E</a> - <a href="#F">F</a> - <a href="#G">G</a> - <a href="#I">I</a> - <a href="#L">L</a> - <a href="#M">M</a> - <a href="#N">N</a> - <a href="#P">P</a> - <a href="#R">R</a> - <a href="#S">S</a> - <a href="#T">T</a> - <a href="#U">U</a> - <a href="#V">V</a> - <a href="#W">W</a> - _</p>
|
||||
<ul id="summaryTree">
|
||||
<li>__init__<ul><li><code data-type="Method"><a href="fn_gen.dg2052.DG2052.html#__init__" class="internal-link">fn_gen.dg2052.DG2052.__init__</a></code></li><li><code data-type="Method"><a href="fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.html#__init__" class="internal-link">fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.__init__</a></code></li><li><code data-type="Method"><a href="fn_gen.errors.undefined_value_error.UndefinedValueError.html#__init__" class="internal-link">fn_gen.errors.undefined_value_error.UndefinedValueError.__init__</a></code></li><li><code data-type="Method"><a href="fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.html#__init__" class="internal-link">fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.__init__</a></code></li></ul></li>
|
||||
<li class="private">__comm - <code data-type="Instance Variable"><a href="fn_gen.dg2052.DG2052.html#__comm" class="internal-link">fn_gen.dg2052.DG2052.__comm</a></code></li><li>__init__<ul><li><code data-type="Method"><a href="fn_gen.dg2052.DG2052.html#__init__" class="internal-link">fn_gen.dg2052.DG2052.__init__</a></code></li><li><code data-type="Method"><a href="fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.html#__init__" class="internal-link">fn_gen.errors.undefined_communication_method_error.UndefinedCommunicationMethodError.__init__</a></code></li><li><code data-type="Method"><a href="fn_gen.errors.undefined_value_error.UndefinedValueError.html#__init__" class="internal-link">fn_gen.errors.undefined_value_error.UndefinedValueError.__init__</a></code></li><li><code data-type="Method"><a href="fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.html#__init__" class="internal-link">fn_gen.errors.value_out_of_bounds_error.ValueOutOfBoundsError.__init__</a></code></li></ul></li><li class="private">__port - <code data-type="Instance Variable"><a href="fn_gen.dg2052.DG2052.html#__port" class="internal-link">fn_gen.dg2052.DG2052.__port</a></code></li><li class="private">__rm - <code data-type="Instance Variable"><a href="fn_gen.dg2052.DG2052.html#__rm" class="internal-link">fn_gen.dg2052.DG2052.__rm</a></code></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -302,7 +302,7 @@
|
||||
<div class="container">
|
||||
<a href="index.html">API Documentation</a> for fn_gen,
|
||||
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
||||
23.9.1 at 2024-02-06 18:56:15.
|
||||
23.9.1 at 2024-02-29 14:55:42.
|
||||
</div>
|
||||
|
||||
<!-- Search related scripts needs to be loaded at the end of HTML
|
||||
|
||||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user