source: sasview/guiframe/docs/sphinx/_build/html/api/version.html @ d955bf19

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 d955bf19 was d955bf19, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 10.3 KB
RevLine 
[d955bf19]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"><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>Returns the last version number that was read from the server.</dd></dl>
75
76<dl class="method">
77<dt id="sans.guiframe.version.VersionChecker.is_complete">
78<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>
79<dd>Method used to poll the reading process. The process will be killed
80if the wait time is longer than a predefined maximum.
81This method should always be called before get_version() to ensure
82accuracy of the version number that is returned.</dd></dl>
83
84</dd></dl>
85
86<dl class="class">
87<dt id="sans.guiframe.version.VersionThread">
88<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>
89<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></tt></p>
90<p>Thread used to start the process of reading the current version of an
91application from the deployment server.</p>
92<p>The VersionChecker is user in a Thread to allow the main application
93to continue dealing with UI requests from the user. The main application
94provides a call-back method for when the version number is obtained.</p>
95<dl class="method">
96<dt id="sans.guiframe.version.VersionThread.getName">
97<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>
98<dd></dd></dl>
99
100<dl class="method">
101<dt id="sans.guiframe.version.VersionThread.isAlive">
102<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>
103<dd></dd></dl>
104
105<dl class="method">
106<dt id="sans.guiframe.version.VersionThread.isDaemon">
107<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>
108<dd></dd></dl>
109
110<dl class="method">
111<dt id="sans.guiframe.version.VersionThread.join">
112<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>
113<dd></dd></dl>
114
115<dl class="method">
116<dt id="sans.guiframe.version.VersionThread.run">
117<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>
118<dd>Execute the process of reading the current application version number.</dd></dl>
119
120<dl class="method">
121<dt id="sans.guiframe.version.VersionThread.setDaemon">
122<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>
123<dd></dd></dl>
124
125<dl class="method">
126<dt id="sans.guiframe.version.VersionThread.setName">
127<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>
128<dd></dd></dl>
129
130<dl class="method">
131<dt id="sans.guiframe.version.VersionThread.start">
132<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>
133<dd></dd></dl>
134
135</dd></dl>
136
137<dl class="function">
138<dt id="sans.guiframe.version.write_version">
139<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>
140<dd>Store the version number
141This could be put into a DB if the application has one.</dd></dl>
142
143</div>
144</div>
145
146
147          </div>
148        </div>
149      </div>
150      <div class="sphinxsidebar">
151        <div class="sphinxsidebarwrapper">
152  <h3><a href="../index.html">Table Of Contents</a></h3>
153  <ul>
154<li><a class="reference internal" href="#">version</a><ul>
155<li><a class="reference internal" href="#module-sans.guiframe.version"><tt class="docutils literal"><span class="pre">sans.guiframe.version</span></tt></a></li>
156</ul>
157</li>
158</ul>
159
160  <h4>Previous topic</h4>
161  <p class="topless"><a href="utils.html"
162                        title="previous chapter">utils</a></p>
163  <h4>Next topic</h4>
164  <p class="topless"><a href="local_perspectives/plotting/index.html"
165                        title="next chapter">Local Perspective: Plotting</a></p>
166  <h3>This Page</h3>
167  <ul class="this-page-menu">
168    <li><a href="../_sources/api/version.txt"
169           rel="nofollow">Show Source</a></li>
170  </ul>
171<div id="searchbox" style="display: none">
172  <h3>Quick search</h3>
173    <form class="search" action="../search.html" method="get">
174      <input type="text" name="q" size="18" />
175      <input type="submit" value="Go" />
176      <input type="hidden" name="check_keywords" value="yes" />
177      <input type="hidden" name="area" value="default" />
178    </form>
179    <p class="searchtip" style="font-size: 90%">
180    Enter search terms or a module, class or function name.
181    </p>
182</div>
183<script type="text/javascript">$('#searchbox').show(0);</script>
184        </div>
185      </div>
186      <div class="clearer"></div>
187    </div>
188    <div class="related">
189      <h3>Navigation</h3>
190      <ul>
191        <li class="right" style="margin-right: 10px">
192          <a href="../genindex.html" title="General Index"
193             >index</a></li>
194        <li class="right" >
195          <a href="../py-modindex.html" title="Python Module Index"
196             >modules</a> |</li>
197        <li class="right" >
198          <a href="local_perspectives/plotting/index.html" title="Local Perspective: Plotting"
199             >next</a> |</li>
200        <li class="right" >
201          <a href="utils.html" title="utils"
202             >previous</a> |</li>
203        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
204          <li><a href="index.html" >Reference</a> &raquo;</li> 
205      </ul>
206    </div>
207    <div class="footer">
208        &copy; Copyright 2010, sans group.
209      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
210    </div>
211  </body>
212</html>
Note: See TracBrowser for help on using the repository browser.