source: sasview/sansguiframe/docs/sphinx/html/api/version.html @ 546521e

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 546521e was 96cbb53, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 10.4 KB
RevLine 
[96cbb53]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<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>version &mdash; guiframe v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="guiframe v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="Local Perspective: plotting" href="local_perspectives/plotting/index.html" />
28    <link rel="prev" title="utils" href="utils.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="local_perspectives/plotting/index.html" title="Local Perspective: plotting"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="utils.html" title="utils"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="version">
57<h1>version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.version">
59<span id="sans-guiframe-version"></span><h2><a class="reference internal" href="#module-sans.guiframe.version" title="sans.guiframe.version"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.version</span></tt></a><a class="headerlink" href="#module-sans.guiframe.version" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.version.VersionChecker">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.version.</tt><tt class="descname">VersionChecker</tt><big>(</big><em>version_url</em><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionChecker" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
64<p>Class of objects used to obtain the current version of an application
65from the deployment server.
66A sub process is started to read the URL associated with the version number.
67The version number is written on file locally before the reading process
68ends, then read when the version number is requested.</p>
69<p>The reading of the URL is put in a separate process so that it doesn&#8217;t
70affect the performance of the application and can be managed and stopped at any time.</p>
71<dl class="method">
72<dt id="sans.guiframe.version.VersionChecker.get_version">
73<tt class="descname">get_version</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionChecker.get_version" title="Permalink to this definition">¶</a></dt>
74<dd><p>Returns the last version number that was read from the server.</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.guiframe.version.VersionChecker.is_complete">
79<tt class="descname">is_complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionChecker.is_complete" title="Permalink to this definition">¶</a></dt>
80<dd><p>Method used to poll the reading process. The process will be killed
81if the wait time is longer than a predefined maximum.
82This method should always be called before get_version() to ensure
83accuracy of the version number that is returned.</p>
84</dd></dl>
85
86</dd></dl>
87
88<dl class="class">
89<dt id="sans.guiframe.version.VersionThread">
90<em class="property">class </em><tt class="descclassname">sans.guiframe.version.</tt><tt class="descname">VersionThread</tt><big>(</big><em>url</em>, <em>call_back=None</em>, <em>baggage=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread" title="Permalink to this definition">¶</a></dt>
91<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></tt></p>
92<p>Thread used to start the process of reading the current version of an
93application from the deployment server.</p>
94<p>The VersionChecker is user in a Thread to allow the main application
95to continue dealing with UI requests from the user. The main application
96provides a call-back method for when the version number is obtained.</p>
97<dl class="method">
98<dt id="sans.guiframe.version.VersionThread.getName">
99<tt class="descname">getName</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.getName" title="Permalink to this definition">¶</a></dt>
100<dd></dd></dl>
101
102<dl class="method">
103<dt id="sans.guiframe.version.VersionThread.isAlive">
104<tt class="descname">isAlive</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.isAlive" title="Permalink to this definition">¶</a></dt>
105<dd></dd></dl>
106
107<dl class="method">
108<dt id="sans.guiframe.version.VersionThread.isDaemon">
109<tt class="descname">isDaemon</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.isDaemon" title="Permalink to this definition">¶</a></dt>
110<dd></dd></dl>
111
112<dl class="method">
113<dt id="sans.guiframe.version.VersionThread.join">
114<tt class="descname">join</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.join" title="Permalink to this definition">¶</a></dt>
115<dd></dd></dl>
116
117<dl class="method">
118<dt id="sans.guiframe.version.VersionThread.run">
119<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.run" title="Permalink to this definition">¶</a></dt>
120<dd><p>Execute the process of reading the current application version number.</p>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.guiframe.version.VersionThread.setDaemon">
125<tt class="descname">setDaemon</tt><big>(</big><em>daemonic</em><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.setDaemon" title="Permalink to this definition">¶</a></dt>
126<dd></dd></dl>
127
128<dl class="method">
129<dt id="sans.guiframe.version.VersionThread.setName">
130<tt class="descname">setName</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.setName" title="Permalink to this definition">¶</a></dt>
131<dd></dd></dl>
132
133<dl class="method">
134<dt id="sans.guiframe.version.VersionThread.start">
135<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.version.VersionThread.start" title="Permalink to this definition">¶</a></dt>
136<dd></dd></dl>
137
138</dd></dl>
139
140<dl class="function">
141<dt id="sans.guiframe.version.write_version">
142<tt class="descclassname">sans.guiframe.version.</tt><tt class="descname">write_version</tt><big>(</big><em>version</em>, <em>filename='.current_version'</em><big>)</big><a class="headerlink" href="#sans.guiframe.version.write_version" title="Permalink to this definition">¶</a></dt>
143<dd><p>Store the version number
144This could be put into a DB if the application has one.</p>
145</dd></dl>
146
147</div>
148</div>
149
150
151          </div>
152        </div>
153      </div>
154      <div class="sphinxsidebar">
155        <div class="sphinxsidebarwrapper">
156  <h3><a href="../index.html">Table Of Contents</a></h3>
157  <ul>
158<li><a class="reference internal" href="#">version</a><ul>
159<li><a class="reference internal" href="#module-sans.guiframe.version"><tt class="docutils literal"><span class="pre">sans.guiframe.version</span></tt></a></li>
160</ul>
161</li>
162</ul>
163
164  <h4>Previous topic</h4>
165  <p class="topless"><a href="utils.html"
166                        title="previous chapter">utils</a></p>
167  <h4>Next topic</h4>
168  <p class="topless"><a href="local_perspectives/plotting/index.html"
169                        title="next chapter">Local Perspective: plotting</a></p>
170  <h3>This Page</h3>
171  <ul class="this-page-menu">
172    <li><a href="../_sources/api/version.txt"
173           rel="nofollow">Show Source</a></li>
174  </ul>
175<div id="searchbox" style="display: none">
176  <h3>Quick search</h3>
177    <form class="search" action="../search.html" method="get">
178      <input type="text" name="q" size="18" />
179      <input type="submit" value="Go" />
180      <input type="hidden" name="check_keywords" value="yes" />
181      <input type="hidden" name="area" value="default" />
182    </form>
183    <p class="searchtip" style="font-size: 90%">
184    Enter search terms or a module, class or function name.
185    </p>
186</div>
187<script type="text/javascript">$('#searchbox').show(0);</script>
188        </div>
189      </div>
190      <div class="clearer"></div>
191    </div>
192    <div class="related">
193      <h3>Navigation</h3>
194      <ul>
195        <li class="right" style="margin-right: 10px">
196          <a href="../genindex.html" title="General Index"
197             >index</a></li>
198        <li class="right" >
199          <a href="../py-modindex.html" title="Python Module Index"
200             >modules</a> |</li>
201        <li class="right" >
202          <a href="local_perspectives/plotting/index.html" title="Local Perspective: plotting"
203             >next</a> |</li>
204        <li class="right" >
205          <a href="utils.html" title="utils"
206             >previous</a> |</li>
207        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
208          <li><a href="index.html" >Reference</a> &raquo;</li> 
209      </ul>
210    </div>
211    <div class="footer">
212        &copy; Copyright 2010, sans group.
213      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
214    </div>
215  </body>
216</html>
Note: See TracBrowser for help on using the repository browser.