source: sasview/calculatorview/docs/sphinx/html/api/perspectives/calculator/resolcal_thread.html @ 5f50326

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 5f50326 was 5f50326, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit calculator docs
  • Property mode set to 100644
File size: 11.3 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>resolcal_thread &mdash; calculatorview 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../../../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../../../_static/jquery.js"></script>
26    <script type="text/javascript" src="../../../_static/underscore.js"></script>
27    <script type="text/javascript" src="../../../_static/doctools.js"></script>
28    <link rel="top" title="calculatorview 0.1.0 documentation" href="../../../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="resolution_calculator_panel" href="resolution_calculator_panel.html" />
31    <link rel="prev" title="pyconsole" href="pyconsole.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../../../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../../../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="resolution_calculator_panel.html" title="resolution_calculator_panel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="pyconsole.html" title="pyconsole"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../../index.html">calculatorview 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="resolcal-thread">
60<h1>resolcal_thread<a class="headerlink" href="#resolcal-thread" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-perspectives-calculator-resolcal-thread">
62<h2><a class="reference internal" href="#module-sans.perspectives.calculator.resolcal_thread" title="sans.perspectives.calculator.resolcal_thread"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.calculator.resolcal_thread</span></tt></a><a class="headerlink" href="#sans-perspectives-calculator-resolcal-thread" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.perspectives.calculator.resolcal_thread"></span><p>Thread for Resolution computation</p>
64<dl class="class">
65<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes">
66<em class="property">class </em><tt class="descclassname">sans.perspectives.calculator.resolcal_thread.</tt><tt class="descname">CalcRes</tt><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes" title="Permalink to this definition">¶</a></dt>
67<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p>
68<p>Compute Resolution</p>
69<dl class="method">
70<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.__init__">
71<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.__init__" title="Permalink to this definition">¶</a></dt>
72<dd></dd></dl>
73
74<dl class="attribute">
75<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.__module__">
76<tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.calculator.resolcal_thread'</em><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.__module__" title="Permalink to this definition">¶</a></dt>
77<dd></dd></dl>
78
79<dl class="method">
80<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes._run">
81<tt class="descname">_run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes._run" title="Permalink to this definition">¶</a></dt>
82<dd><p>Internal function to manage the thread.</p>
83</dd></dl>
84
85<dl class="method">
86<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.complete">
87<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.complete" title="Permalink to this definition">¶</a></dt>
88<dd><p>Update the GUI with the completed results from a work unit.</p>
89</dd></dl>
90
91<dl class="method">
92<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.compute">
93<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.compute" title="Permalink to this definition">¶</a></dt>
94<dd><p>excuting computation</p>
95</dd></dl>
96
97<dl class="method">
98<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.interrupt">
99<tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.interrupt" title="Permalink to this definition">¶</a></dt>
100<dd><p>Stop the current work item.  To clear the work queue as
101well call the stop() method.</p>
102</dd></dl>
103
104<dl class="method">
105<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.isquit">
106<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.isquit" title="Permalink to this definition">¶</a></dt>
107<dd><p>Check for interrupts.  Should be called frequently to
108provide user responsiveness.  Also yields to other running
109threads, which is required for good performance on OS X.</p>
110</dd></dl>
111
112<dl class="method">
113<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.isrunning">
114<tt class="descname">isrunning</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.isrunning" title="Permalink to this definition">¶</a></dt>
115<dd></dd></dl>
116
117<dl class="method">
118<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.queue">
119<tt class="descname">queue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.queue" title="Permalink to this definition">¶</a></dt>
120<dd><p>Add a work unit to the end of the queue.  See the compute()
121method for details of the arguments to the work unit.</p>
122</dd></dl>
123
124<dl class="method">
125<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.ready">
126<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.ready" title="Permalink to this definition">¶</a></dt>
127<dd><p>Ready for another update after delay=t seconds.  Call
128this for threads which can show intermediate results from
129long calculations.</p>
130</dd></dl>
131
132<dl class="method">
133<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.requeue">
134<tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.requeue" title="Permalink to this definition">¶</a></dt>
135<dd><p>Replace the work unit on the end of the queue.  See the compute()
136method for details of the arguments to the work unit.</p>
137</dd></dl>
138
139<dl class="method">
140<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.reset">
141<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.reset" title="Permalink to this definition">¶</a></dt>
142<dd><p>Clear the queue and start a new work unit.  See the compute()
143method for details of the arguments to the work unit.</p>
144</dd></dl>
145
146<dl class="method">
147<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.stop">
148<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.stop" title="Permalink to this definition">¶</a></dt>
149<dd><p>Clear the queue and stop the thread.  New items may be
150queued after stop.  To stop just the current work item, and
151continue the rest of the queue call the interrupt method</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.perspectives.calculator.resolcal_thread.CalcRes.update">
156<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.calculator.resolcal_thread.CalcRes.update" title="Permalink to this definition">¶</a></dt>
157<dd><p>Update GUI with the lastest results from the current work unit.</p>
158</dd></dl>
159
160</dd></dl>
161
162</div>
163</div>
164
165
166          </div>
167        </div>
168      </div>
169      <div class="sphinxsidebar">
170        <div class="sphinxsidebarwrapper">
171  <h3><a href="../../../index.html">Table Of Contents</a></h3>
172  <ul>
173<li><a class="reference internal" href="#">resolcal_thread</a><ul>
174<li><a class="reference internal" href="#sans-perspectives-calculator-resolcal-thread"><tt class="docutils literal"><span class="pre">sans.perspectives.calculator.resolcal_thread</span></tt></a></li>
175</ul>
176</li>
177</ul>
178
179  <h4>Previous topic</h4>
180  <p class="topless"><a href="pyconsole.html"
181                        title="previous chapter">pyconsole</a></p>
182  <h4>Next topic</h4>
183  <p class="topless"><a href="resolution_calculator_panel.html"
184                        title="next chapter">resolution_calculator_panel</a></p>
185  <h3>This Page</h3>
186  <ul class="this-page-menu">
187    <li><a href="../../../_sources/api/perspectives/calculator/resolcal_thread.txt"
188           rel="nofollow">Show Source</a></li>
189  </ul>
190<div id="searchbox" style="display: none">
191  <h3>Quick search</h3>
192    <form class="search" action="../../../search.html" method="get">
193      <input type="text" name="q" />
194      <input type="submit" value="Go" />
195      <input type="hidden" name="check_keywords" value="yes" />
196      <input type="hidden" name="area" value="default" />
197    </form>
198    <p class="searchtip" style="font-size: 90%">
199    Enter search terms or a module, class or function name.
200    </p>
201</div>
202<script type="text/javascript">$('#searchbox').show(0);</script>
203        </div>
204      </div>
205      <div class="clearer"></div>
206    </div>
207    <div class="related">
208      <h3>Navigation</h3>
209      <ul>
210        <li class="right" style="margin-right: 10px">
211          <a href="../../../genindex.html" title="General Index"
212             >index</a></li>
213        <li class="right" >
214          <a href="../../../py-modindex.html" title="Python Module Index"
215             >modules</a> |</li>
216        <li class="right" >
217          <a href="resolution_calculator_panel.html" title="resolution_calculator_panel"
218             >next</a> |</li>
219        <li class="right" >
220          <a href="pyconsole.html" title="pyconsole"
221             >previous</a> |</li>
222        <li><a href="../../../index.html">calculatorview 0.1.0 documentation</a> &raquo;</li>
223          <li><a href="index.html" >Reference</a> &raquo;</li> 
224      </ul>
225    </div>
226    <div class="footer">
227        &copy; Copyright 2010, sans group.
228      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
229    </div>
230  </body>
231</html>
Note: See TracBrowser for help on using the repository browser.