PyPI - quarchpy - Versions diffs - 2.2.9.dev4__py2.py3-none-any.whl → 2.2.10__py2.py3-none-any.whl - Mend

quarchpy 2.2.9.dev4py2.py3-none-any.whl → 2.2.10py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1892) hide show

quarchpy/docs/_build/html/source/quarchpy.user_interface.html CHANGED Viewed

@@ -1,279 +1,279 @@
-<!DOCTYPE html>
-<html lang="en" data-content_root="../">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
-    <title>quarchpy.user_interface package &#8212; quarchpy  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
-    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
-    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=9bcbadda"></script>
-    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
-    <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="quarchpy.utilities package" href="quarchpy.utilities.html" />
-    <link rel="prev" title="quarchpy.iometer package" href="quarchpy.iometer.html" />
-  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
-  </head><body>
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-  <section id="quarchpy-user-interface-package">
-<h1>quarchpy.user_interface package<a class="headerlink" href="#quarchpy-user-interface-package" title="Link to this heading">¶</a></h1>
-<section id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
-</section>
-<section id="module-quarchpy.user_interface.user_interface">
-<span id="quarchpy-user-interface-user-interface-module"></span><h2>quarchpy.user_interface.user_interface module<a class="headerlink" href="#module-quarchpy.user_interface.user_interface" title="Link to this heading">¶</a></h2>
-<p>This module provides standard user interface elements to quarchpy functions, ensuring common style
-and support for both terminal and TestCenter (quarch internal) execution</p>
-<dl class="py class">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.User_interface">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">User_interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ui</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.User_interface" title="Link to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<p>This class is a singleton pattern and provides common access to the user interace for user
-interaction.  The UI can be the terminal or TestCenter</p>
-<dl class="py attribute">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.User_interface.instance">
-<span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#quarchpy.user_interface.user_interface.User_interface.instance" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.check_path_write_permissions">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">check_path_write_permissions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Please</span> <span class="pre">enter</span> <span class="pre">a</span> <span class="pre">valid</span> <span class="pre">path</span> <span class="pre">with</span> <span class="pre">write</span> <span class="pre">permissions:</span> <span class="pre">'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.check_path_write_permissions" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.dictToList">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">dictToList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableData</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.dictToList" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.displayTable">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">displayTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[['']]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">printToConsole</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.displayTable" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.endTestBlock">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">endTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'End</span> <span class="pre">test</span> <span class="pre">block'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.endTestBlock" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.get_check_valid_calPath">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">get_check_valid_calPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">calPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Enter</span> <span class="pre">the</span> <span class="pre">desired</span> <span class="pre">save</span> <span class="pre">path</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">calibration</span> <span class="pre">report.'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.get_check_valid_calPath" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.is_user_admin">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">is_user_admin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.is_user_admin" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.listSelection">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">listSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selectionList</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.listSelection" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logCalibrationResult">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logCalibrationResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">report</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logCalibrationResult" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logDebug">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logDebug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logDebug" title="Link to this definition">¶</a></dt>
-<dd><p>Processes a debug message and diaplays it using python standard logging or a debug message in test centre.
-:param text - a string of text:
-:param or a list of strings:</p>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logResults">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">test</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logResults" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logSimpleResult">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logSimpleResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logSimpleResult" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logWarning">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logWarning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logWarning" title="Link to this definition">¶</a></dt>
-<dd><p>Processes a warning message and diaplays it using python standard logging or a warning message in test centre.
-:param text - a string of text:
-:param or a list of strings:</p>
-</dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.niceListSelection">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">niceListSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">selectionList</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.niceListSelection" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.printText">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">printText</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillLine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminalWidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.printText" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.progressBar">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">progressBar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iteration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decimals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'█'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fullWidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.progressBar" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.quarchSleep">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">quarchSleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sleepLength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updatePeriod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.quarchSleep" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.requestDialog">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">requestDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desiredType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minRange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxRange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">defaultUserInput</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.requestDialog" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.setup_logging">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logLevel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.setup_logging" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showDialog">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showDialog" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showImage">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">imagePath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showImage" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showYesNoDialog">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showYesNoDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showYesNoDialog" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.startTestBlock">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">startTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.startTestBlock" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.storeResult">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">storeResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.storeResult" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.userRangeIntSelection">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">userRangeIntSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inputString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intLength</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.userRangeIntSelection" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.validateUserInput">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">validateUserInput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">userStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desiredType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minRange</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxRange</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.validateUserInput" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-<dl class="py function">
-<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.visual_sleep">
-<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">visual_sleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sleepLength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updatePeriod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.visual_sleep" title="Link to this definition">¶</a></dt>
-<dd><p>Wrapper for sleep function that gives a visual indicator of the sleep time</p>
-</dd></dl>
-</section>
-<section id="module-quarchpy.user_interface">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.user_interface" title="Link to this heading">¶</a></h2>
-</section>
-</section>
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
-        <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="../index.html">quarchpy</a></h1>
-<search id="searchbox" style="display: none" role="search">
-    <div class="searchformwrapper">
-    <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
-      <input type="submit" value="Go" />
-    </form>
-    </div>
-</search>
-<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Quarchpy)</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="modules.html">quarchpy</a><ul class="current">
-<li class="toctree-l2 current"><a class="reference internal" href="quarchpy.html">quarchpy package</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="readme.html">Quarchpy - Readme</a></li>
-<li class="toctree-l1"><a class="reference internal" href="licenses.html">LICENSES</a></li>
-</ul>
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="../index.html">Documentation overview</a><ul>
-  <li><a href="modules.html">quarchpy</a><ul>
-  <li><a href="quarchpy.html">quarchpy package</a><ul>
-      <li>Previous: <a href="quarchpy.iometer.html" title="previous chapter">quarchpy.iometer package</a></li>
-      <li>Next: <a href="quarchpy.utilities.html" title="next chapter">quarchpy.utilities package</a></li>
-  </ul></li>
-  </ul></li>
-  </ul></li>
-</ul>
-</div>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="footer">
-      &#169;2020, Quarch Technology Ltd.
-      |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
-      |
-      <a href="../_sources/source/quarchpy.user_interface.rst.txt"
-          rel="nofollow">Page source</a>
-    </div>
-  </body>
+<!DOCTYPE html>
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>quarchpy.user_interface package &#8212; quarchpy  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="quarchpy.utilities package" href="quarchpy.utilities.html" />
+    <link rel="prev" title="quarchpy.iometer package" href="quarchpy.iometer.html" />
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  </head><body>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <section id="quarchpy-user-interface-package">
+<h1>quarchpy.user_interface package<a class="headerlink" href="#quarchpy-user-interface-package" title="Link to this heading">¶</a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
+</section>
+<section id="module-quarchpy.user_interface.user_interface">
+<span id="quarchpy-user-interface-user-interface-module"></span><h2>quarchpy.user_interface.user_interface module<a class="headerlink" href="#module-quarchpy.user_interface.user_interface" title="Link to this heading">¶</a></h2>
+<p>This module provides standard user interface elements to quarchpy functions, ensuring common style
+and support for both terminal and TestCenter (quarch internal) execution</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.User_interface">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">User_interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ui</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.User_interface" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>This class is a singleton pattern and provides common access to the user interace for user
+interaction.  The UI can be the terminal or TestCenter</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.User_interface.instance">
+<span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#quarchpy.user_interface.user_interface.User_interface.instance" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.check_path_write_permissions">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">check_path_write_permissions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Please</span> <span class="pre">enter</span> <span class="pre">a</span> <span class="pre">valid</span> <span class="pre">path</span> <span class="pre">with</span> <span class="pre">write</span> <span class="pre">permissions:</span> <span class="pre">'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.check_path_write_permissions" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.dictToList">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">dictToList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableData</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.dictToList" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.displayTable">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">displayTable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[['']]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">printToConsole</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.displayTable" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.endTestBlock">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">endTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'End</span> <span class="pre">test</span> <span class="pre">block'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.endTestBlock" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.get_check_valid_calPath">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">get_check_valid_calPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">calPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Enter</span> <span class="pre">the</span> <span class="pre">desired</span> <span class="pre">save</span> <span class="pre">path</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">calibration</span> <span class="pre">report.'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.get_check_valid_calPath" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.is_user_admin">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">is_user_admin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.is_user_admin" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.listSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">listSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selectionList</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.listSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logCalibrationResult">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logCalibrationResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">report</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logCalibrationResult" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logDebug">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logDebug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logDebug" title="Link to this definition">¶</a></dt>
+<dd><p>Processes a debug message and diaplays it using python standard logging or a debug message in test centre.
+:param text - a string of text:
+:param or a list of strings:</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logResults">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">test</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logResults" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logSimpleResult">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logSimpleResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logSimpleResult" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.logWarning">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">logWarning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.logWarning" title="Link to this definition">¶</a></dt>
+<dd><p>Processes a warning message and diaplays it using python standard logging or a warning message in test centre.
+:param text - a string of text:
+:param or a list of strings:</p>
+</dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.niceListSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">niceListSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">selectionList</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableHeaders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexReq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additionalOptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'l'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.niceListSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.printText">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">printText</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillLine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminalWidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.printText" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.progressBar">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">progressBar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iteration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decimals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'█'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fullWidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.progressBar" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.quarchSleep">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">quarchSleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sleepLength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updatePeriod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.quarchSleep" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.requestDialog">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">requestDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desiredType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minRange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxRange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">defaultUserInput</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.requestDialog" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.setup_logging">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logLevel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.setup_logging" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showDialog">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showDialog" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showImage">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">imagePath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showImage" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.showYesNoDialog">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">showYesNoDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.showYesNoDialog" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.startTestBlock">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">startTestBlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.startTestBlock" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.storeResult">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">storeResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.storeResult" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.userRangeIntSelection">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">userRangeIntSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inputString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intLength</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.userRangeIntSelection" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.validateUserInput">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">validateUserInput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">userStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desiredType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minRange</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxRange</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.validateUserInput" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="quarchpy.user_interface.user_interface.visual_sleep">
+<span class="sig-prename descclassname"><span class="pre">quarchpy.user_interface.user_interface.</span></span><span class="sig-name descname"><span class="pre">visual_sleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sleepLength</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updatePeriod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quarchpy.user_interface.user_interface.visual_sleep" title="Link to this definition">¶</a></dt>
+<dd><p>Wrapper for sleep function that gives a visual indicator of the sleep time</p>
+</dd></dl>
+</section>
+<section id="module-quarchpy.user_interface">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-quarchpy.user_interface" title="Link to this heading">¶</a></h2>
+</section>
+</section>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">quarchpy</a></h1>
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Quarchpy)</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">quarchpy</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="quarchpy.html">quarchpy package</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="readme.html">Quarchpy - Readme</a></li>
+<li class="toctree-l1"><a class="reference internal" href="licenses.html">LICENSES</a></li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  <li><a href="modules.html">quarchpy</a><ul>
+  <li><a href="quarchpy.html">quarchpy package</a><ul>
+      <li>Previous: <a href="quarchpy.iometer.html" title="previous chapter">quarchpy.iometer package</a></li>
+      <li>Next: <a href="quarchpy.utilities.html" title="next chapter">quarchpy.utilities package</a></li>
+  </ul></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2020, Quarch Technology Ltd.
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+      |
+      <a href="../_sources/source/quarchpy.user_interface.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+  </body>
 </html>

quarchpy 2.2.9.dev4__py2.py3-none-any.whl → 2.2.10__py2.py3-none-any.whl

quarchpy 2.2.9.dev4py2.py3-none-any.whl → 2.2.10py2.py3-none-any.whl