166 lines
8.1 KiB
HTML
166 lines
8.1 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
|
|
|
|
<head>
|
|
|
|
<title>Module Index</title>
|
|
<meta name="generator" content="pydoctor 23.9.1">
|
|
|
|
</meta>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
|
|
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="apidocs.css" />
|
|
<link rel="stylesheet" type="text/css" href="extra.css" />
|
|
</head>
|
|
|
|
<body>
|
|
|
|
|
|
|
|
<nav class="navbar navbar-default mainnavbar">
|
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
|
|
<div class="navbar-header">
|
|
|
|
<div class="navlinks">
|
|
<span class="navbar-brand">
|
|
fn_gen <a href="index.html">API Documentation</a>
|
|
</span>
|
|
|
|
<a href="moduleIndex.html">
|
|
Modules
|
|
</a>
|
|
|
|
<a href="classIndex.html">
|
|
Classes
|
|
</a>
|
|
|
|
<a href="nameIndex.html">
|
|
Names
|
|
</a>
|
|
|
|
<div id="search-box-container">
|
|
<div class="input-group">
|
|
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
|
|
|
|
<span class="input-group-btn">
|
|
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
|
|
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="search-results-container" style="display: none;">
|
|
|
|
<div id="search-buttons">
|
|
<span class="label label-default" id="search-docstrings-button">
|
|
<label class="checkbox-inline">
|
|
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
|
|
search in docstrings
|
|
</input>
|
|
</label>
|
|
</span>
|
|
|
|
</div>
|
|
|
|
<noscript>
|
|
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
|
|
</noscript>
|
|
|
|
<div class="hint" id="search-help-box">
|
|
<p class="rst-last">
|
|
|
|
Search bar offers the following options:
|
|
<ul>
|
|
<li>
|
|
<strong>Term presence.</strong> The below example searches for documents that
|
|
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Search in specific fields.</strong> The following search matches all objects
|
|
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
|
|
|
|
<p>
|
|
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
|
|
Last two fields are only applicable if "search in docstrings" is enabled.
|
|
</p>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Fuzzy matches.</strong> The following search matches all documents
|
|
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
|
|
</li>
|
|
</ul>
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="search-status"> </div>
|
|
|
|
<div class="warning" id="search-warn-box" style="display: none;">
|
|
<p class="rst-last"><span id="search-warn"></span></p>
|
|
</div>
|
|
|
|
<table id="search-results">
|
|
<!-- Filled dynamically by JS -->
|
|
</table>
|
|
|
|
<div style="margin-top: 8px;">
|
|
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="container-fluid">
|
|
|
|
<div class="page-header">
|
|
<h1>Module Index</h1>
|
|
<div id="showPrivate">
|
|
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
|
|
</div>
|
|
</div>
|
|
|
|
<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>
|
|
|
|
<footer class="navbar navbar-default">
|
|
|
|
|
|
<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-29 14:55:42.
|
|
</div>
|
|
|
|
<!-- Search related scripts needs to be loaded at the end of HTML
|
|
parsing not to introduce overhead and display HTML data asap -->
|
|
<script src="ajax.js" type="text/javascript"></script>
|
|
<script src="searchlib.js" type="text/javascript"></script>
|
|
<script src="search.js" type="text/javascript"></script>
|
|
|
|
</footer>
|
|
|
|
<script src="pydoctor.js" type="text/javascript"></script>
|
|
|
|
</body>
|
|
</html> |