Ignore:
Timestamp:
Oct 24, 2011 2:43:40 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
67cd7c0
Parents:
70ecd530
Message:

sphinx build

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sansguiframe/docs/sphinx/html/api/local_perspectives/data_loader/load_thread.html

    r96cbb53 rbce8148  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>load_thread &mdash; guiframe v0.1.0 documentation</title> 
     11    <title>load_thread &mdash; guiframe 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../../../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../../../_static/doctools.js"></script> 
    25     <link rel="top" title="guiframe v0.1.0 documentation" href="../../../index.html" /> 
     28    <link rel="top" title="guiframe 0.1.0 documentation" href="../../../index.html" /> 
    2629    <link rel="up" title="Local Perspective: data_loader" href="index.html" /> 
    2730    <link rel="prev" title="help_panel" href="help_panel.html" />  
    … …  
    4043          <a href="help_panel.html" title="help_panel" 
    4144             accesskey="P">previous</a> |</li> 
    42         <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li> 
     45        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li> 
    4346          <li><a href="index.html" accesskey="U">Local Perspective: data_loader</a> &raquo;</li>  
    4447      </ul> 
    … …  
    5356<h1>load_thread<a class="headerlink" href="#load-thread" title="Permalink to this headline">¶</a></h1> 
    5457<div class="section" id="sans-guiframe-local-perspectives-data-loader-load-thread"> 
    55 <h2><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.data_loader.load_thread</span></tt><a class="headerlink" href="#sans-guiframe-local-perspectives-data-loader-load-thread" title="Permalink to this headline">¶</a></h2> 
     58<h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.data_loader.load_thread" title="sans.guiframe.local_perspectives.data_loader.load_thread"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.data_loader.load_thread</span></tt></a><a class="headerlink" href="#sans-guiframe-local-perspectives-data-loader-load-thread" title="Permalink to this headline">¶</a></h2> 
     59<span class="target" id="module-sans.guiframe.local_perspectives.data_loader.load_thread"></span><dl class="class"> 
     60<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader"> 
     61<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.data_loader.load_thread.</tt><tt class="descname">DataReader</tt><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader" title="Permalink to this definition">¶</a></dt> 
     62<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p> 
     63<p>Load a data given a filename</p> 
     64<dl class="method"> 
     65<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.__init__"> 
     66<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.__init__" title="Permalink to this definition">¶</a></dt> 
     67<dd></dd></dl> 
     68 
     69<dl class="attribute"> 
     70<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.__module__"> 
     71<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.local_perspectives.data_loader.load_thread'</em><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.__module__" title="Permalink to this definition">¶</a></dt> 
     72<dd></dd></dl> 
     73 
     74<dl class="method"> 
     75<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader._run"> 
     76<tt class="descname">_run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader._run" title="Permalink to this definition">¶</a></dt> 
     77<dd><p>Internal function to manage the thread.</p> 
     78</dd></dl> 
     79 
     80<dl class="method"> 
     81<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.complete"> 
     82<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.complete" title="Permalink to this definition">¶</a></dt> 
     83<dd><p>Update the GUI with the completed results from a work unit.</p> 
     84</dd></dl> 
     85 
     86<dl class="method"> 
     87<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.compute"> 
     88<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.compute" title="Permalink to this definition">¶</a></dt> 
     89<dd><p>read some data</p> 
     90</dd></dl> 
     91 
     92<dl class="method"> 
     93<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.interrupt"> 
     94<tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.interrupt" title="Permalink to this definition">¶</a></dt> 
     95<dd><p>Stop the current work item.  To clear the work queue as 
     96well call the stop() method.</p> 
     97</dd></dl> 
     98 
     99<dl class="method"> 
     100<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.isquit"> 
     101<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.isquit" title="Permalink to this definition">¶</a></dt> 
     102<dd><table class="docutils field-list" frame="void" rules="none"> 
     103<col class="field-name" /> 
     104<col class="field-body" /> 
     105<tbody valign="top"> 
     106<tr class="field-odd field"><th class="field-name" colspan="2">Raises KeyboardInterrupt:</th></tr> 
     107<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">when the thread is interrupted</td> 
     108</tr> 
     109</tbody> 
     110</table> 
     111</dd></dl> 
     112 
     113<dl class="method"> 
     114<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.isrunning"> 
     115<tt class="descname">isrunning</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.isrunning" title="Permalink to this definition">¶</a></dt> 
     116<dd></dd></dl> 
     117 
     118<dl class="method"> 
     119<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.queue"> 
     120<tt class="descname">queue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.queue" title="Permalink to this definition">¶</a></dt> 
     121<dd><p>Add a work unit to the end of the queue.  See the compute() 
     122method for details of the arguments to the work unit.</p> 
     123</dd></dl> 
     124 
     125<dl class="method"> 
     126<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.ready"> 
     127<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.ready" title="Permalink to this definition">¶</a></dt> 
     128<dd><p>Ready for another update after delay=t seconds.  Call 
     129this for threads which can show intermediate results from 
     130long calculations.</p> 
     131</dd></dl> 
     132 
     133<dl class="method"> 
     134<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.requeue"> 
     135<tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.requeue" title="Permalink to this definition">¶</a></dt> 
     136<dd><p>Replace the work unit on the end of the queue.  See the compute() 
     137method for details of the arguments to the work unit.</p> 
     138</dd></dl> 
     139 
     140<dl class="method"> 
     141<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.reset"> 
     142<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.reset" title="Permalink to this definition">¶</a></dt> 
     143<dd><p>Clear the queue and start a new work unit.  See the compute() 
     144method for details of the arguments to the work unit.</p> 
     145</dd></dl> 
     146 
     147<dl class="method"> 
     148<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.stop"> 
     149<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.stop" title="Permalink to this definition">¶</a></dt> 
     150<dd><p>Clear the queue and stop the thread.  New items may be 
     151queued after stop.  To stop just the current work item, and 
     152continue the rest of the queue call the interrupt method</p> 
     153</dd></dl> 
     154 
     155<dl class="method"> 
     156<dt id="sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.update"> 
     157<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.data_loader.load_thread.DataReader.update" title="Permalink to this definition">¶</a></dt> 
     158<dd><p>Update GUI with the lastest results from the current work unit.</p> 
     159</dd></dl> 
     160 
     161</dd></dl> 
     162 
    56163</div> 
    57164</div> 
    … …  
    82189  <h3>Quick search</h3> 
    83190    <form class="search" action="../../../search.html" method="get"> 
    84       <input type="text" name="q" size="18" /> 
     191      <input type="text" name="q" /> 
    85192      <input type="submit" value="Go" /> 
    86193      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    108215          <a href="help_panel.html" title="help_panel" 
    109216             >previous</a> |</li> 
    110         <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li> 
     217        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li> 
    111218          <li><a href="index.html" >Local Perspective: data_loader</a> &raquo;</li>  
    112219      </ul> 
    … …  
    114221    <div class="footer"> 
    115222        &copy; Copyright 2010, sans group. 
    116       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     223      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    117224    </div> 
    118225  </body> 
Note: See TracChangeset for help on using the changeset viewer.