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/state_reader.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>state_reader &mdash; guiframe v0.1.0 documentation</title> 
     11    <title>state_reader &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="Reference" href="index.html" /> 
    2730    <link rel="next" title="utils" href="utils.html" /> 
    … …  
    4447          <a href="startup_configuration.html" title="startup_configuration" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">guiframe 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="state-reader"> 
    5760<h1>state_reader<a class="headerlink" href="#state-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.guiframe.state_reader"> 
    59 <span id="sans-guiframe-state-reader"></span><h2><a class="reference internal" href="#module-sans.guiframe.state_reader" title="sans.guiframe.state_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.state_reader</span></tt></a><a class="headerlink" href="#module-sans.guiframe.state_reader" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-guiframe-state-reader"> 
     62<h2><a class="reference internal" href="#module-sans.guiframe.state_reader" title="sans.guiframe.state_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.state_reader</span></tt></a><a class="headerlink" href="#sans-guiframe-state-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.guiframe.state_reader"></span><dl class="class"> 
    6164<dt id="sans.guiframe.state_reader.Reader1D"> 
    6265<em class="property">class </em><tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">Reader1D</tt><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D" title="Permalink to this definition">¶</a></dt> 
    … …  
    6669<col class="field-body" /> 
    6770<tbody valign="top"> 
    68 <tr class="field"><th class="field-name">Dependencies :</th><td class="field-body">The CanSas reader requires PyXML 0.8.4 or later.</td> 
    69 </tr> 
    70 </tbody> 
    71 </table> 
     71<tr class="field-odd field"><th class="field-name">Dependencies :</th><td class="field-body">The CanSas reader requires PyXML 0.8.4 or later.</td> 
     72</tr> 
     73</tbody> 
     74</table> 
     75<dl class="method"> 
     76<dt id="sans.guiframe.state_reader.Reader1D.__init__"> 
     77<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.__init__" title="Permalink to this definition">¶</a></dt> 
     78<dd></dd></dl> 
     79 
     80<dl class="attribute"> 
     81<dt id="sans.guiframe.state_reader.Reader1D.__module__"> 
     82<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.state_reader'</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.__module__" title="Permalink to this definition">¶</a></dt> 
     83<dd></dd></dl> 
     84 
     85<dl class="method"> 
     86<dt id="sans.guiframe.state_reader.Reader1D._parse_entry"> 
     87<tt class="descname">_parse_entry</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D._parse_entry" title="Permalink to this definition">¶</a></dt> 
     88<dd><p>Parse a SASentry</p> 
     89<table class="docutils field-list" frame="void" rules="none"> 
     90<col class="field-name" /> 
     91<col class="field-body" /> 
     92<tbody valign="top"> 
     93<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> &#8211; SASentry node</td> 
     94</tr> 
     95<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td> 
     96</tr> 
     97</tbody> 
     98</table> 
     99</dd></dl> 
     100 
     101<dl class="method"> 
     102<dt id="sans.guiframe.state_reader.Reader1D._store_content"> 
     103<tt class="descname">_store_content</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D._store_content" title="Permalink to this definition">¶</a></dt> 
     104<dd><p>Get the content of a xpath location and store 
     105the result. The value is treated as a string.</p> 
     106<p>The xpath location might or might not exist. 
     107If it does not exist, nothing is done</p> 
     108<table class="docutils field-list" frame="void" rules="none"> 
     109<col class="field-name" /> 
     110<col class="field-body" /> 
     111<tbody valign="top"> 
     112<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     113<li><strong>location</strong> &#8211; xpath location to fetch</li> 
     114<li><strong>node</strong> &#8211; node to read the data from</li> 
     115<li><strong>variable</strong> &#8211; name of the data member to store it in [string]</li> 
     116<li><strong>storage</strong> &#8211; data object that has the &#8216;variable&#8217; data member</li> 
     117</ul> 
     118</td> 
     119</tr> 
     120<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">return a list of errors</p> 
     121</td> 
     122</tr> 
     123</tbody> 
     124</table> 
     125</dd></dl> 
     126 
     127<dl class="method"> 
     128<dt id="sans.guiframe.state_reader.Reader1D._store_float"> 
     129<tt class="descname">_store_float</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D._store_float" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>Get the content of a xpath location and store 
     131the result. Check that the units are compatible 
     132with the destination. The value is expected to 
     133be a float.</p> 
     134<p>The xpath location might or might not exist. 
     135If it does not exist, nothing is done</p> 
     136<table class="docutils field-list" frame="void" rules="none"> 
     137<col class="field-name" /> 
     138<col class="field-body" /> 
     139<tbody valign="top"> 
     140<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     141<li><strong>location</strong> &#8211; xpath location to fetch</li> 
     142<li><strong>node</strong> &#8211; node to read the data from</li> 
     143<li><strong>variable</strong> &#8211; name of the data member to store it in [string]</li> 
     144<li><strong>storage</strong> &#8211; data object that has the &#8216;variable&#8217; data member</li> 
     145<li><strong>optional</strong> &#8211; if True, no exception will be raised  
     146if unit conversion can&#8217;t be done</li> 
     147</ul> 
     148</td> 
     149</tr> 
     150<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     151<tr class="field-even field"><td>&nbsp;</td><td class="field-body"><p class="first last">raised when the units are not recognized</p> 
     152</td> 
     153</tr> 
     154</tbody> 
     155</table> 
     156</dd></dl> 
     157 
     158<dl class="method"> 
     159<dt id="sans.guiframe.state_reader.Reader1D._to_xml_doc"> 
     160<tt class="descname">_to_xml_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D._to_xml_doc" title="Permalink to this definition">¶</a></dt> 
     161<dd><p>Create an XML document to contain the content of a Data1D</p> 
     162<table class="docutils field-list" frame="void" rules="none"> 
     163<col class="field-name" /> 
     164<col class="field-body" /> 
     165<tbody valign="top"> 
     166<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> &#8211; Data1D object</td> 
     167</tr> 
     168</tbody> 
     169</table> 
     170</dd></dl> 
     171 
     172<dl class="attribute"> 
     173<dt id="sans.guiframe.state_reader.Reader1D.ext"> 
     174<tt class="descname">ext</tt><em class="property"> = []</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.ext" title="Permalink to this definition">¶</a></dt> 
     175<dd></dd></dl> 
     176 
    72177<dl class="method"> 
    73178<dt id="sans.guiframe.state_reader.Reader1D.read"> 
    74 <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.read" title="Permalink to this definition">¶</a></dt> 
     179<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.read" title="Permalink to this definition">¶</a></dt> 
    75180<dd><p>Load data file</p> 
    76181<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    78183<col class="field-body" /> 
    79184<tbody valign="top"> 
    80 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
    81 </td> 
    82 </tr> 
    83 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object if a single SASentry was found,  
     185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
     186</td> 
     187</tr> 
     188<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object if a single SASentry was found,  
    84189or a list of Data1D objects if multiple entries were found, 
    85190or None of nothing was found</p> 
    86191</td> 
    87192</tr> 
    88 <tr class="field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
     193<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
    89194<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li> 
    90195<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li> 
    … …  
    96201</dd></dl> 
    97202 
     203<dl class="attribute"> 
     204<dt id="sans.guiframe.state_reader.Reader1D.type"> 
     205<tt class="descname">type</tt><em class="property"> = []</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.type" title="Permalink to this definition">¶</a></dt> 
     206<dd></dd></dl> 
     207 
     208<dl class="attribute"> 
     209<dt id="sans.guiframe.state_reader.Reader1D.type_name"> 
     210<tt class="descname">type_name</tt><em class="property"> = 'CanSAS 1D'</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.type_name" title="Permalink to this definition">¶</a></dt> 
     211<dd></dd></dl> 
     212 
     213<dl class="attribute"> 
     214<dt id="sans.guiframe.state_reader.Reader1D.version"> 
     215<tt class="descname">version</tt><em class="property"> = '1.0'</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.version" title="Permalink to this definition">¶</a></dt> 
     216<dd></dd></dl> 
     217 
    98218<dl class="method"> 
    99219<dt id="sans.guiframe.state_reader.Reader1D.write"> 
    100 <tt class="descname">write</tt><big>(</big><em>filename</em>, <em>datainfo</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.write" title="Permalink to this definition">¶</a></dt> 
     220<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader1D.write" title="Permalink to this definition">¶</a></dt> 
    101221<dd><p>Write the content of a Data1D as a CanSAS XML file</p> 
    102222<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    104224<col class="field-body" /> 
    105225<tbody valign="top"> 
    106 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     226<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    107227<li><strong>filename</strong> &#8211; name of the file to write</li> 
    108228<li><strong>datainfo</strong> &#8211; Data1D object</li> 
    … …  
    121241<dd><p>Class to load a basic guiframe state</p> 
    122242<dl class="method"> 
     243<dt id="sans.guiframe.state_reader.Reader2D.__init__"> 
     244<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.__init__" title="Permalink to this definition">¶</a></dt> 
     245<dd></dd></dl> 
     246 
     247<dl class="attribute"> 
     248<dt id="sans.guiframe.state_reader.Reader2D.__module__"> 
     249<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.state_reader'</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.__module__" title="Permalink to this definition">¶</a></dt> 
     250<dd></dd></dl> 
     251 
     252<dl class="method"> 
     253<dt id="sans.guiframe.state_reader.Reader2D._parse_entry"> 
     254<tt class="descname">_parse_entry</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D._parse_entry" title="Permalink to this definition">¶</a></dt> 
     255<dd><p>Parse a SASentry</p> 
     256<table class="docutils field-list" frame="void" rules="none"> 
     257<col class="field-name" /> 
     258<col class="field-body" /> 
     259<tbody valign="top"> 
     260<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> &#8211; SASentry node</td> 
     261</tr> 
     262<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D/Data2D object</td> 
     263</tr> 
     264</tbody> 
     265</table> 
     266</dd></dl> 
     267 
     268<dl class="method"> 
     269<dt id="sans.guiframe.state_reader.Reader2D._parse_state"> 
     270<tt class="descname">_parse_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D._parse_state" title="Permalink to this definition">¶</a></dt> 
     271<dd><p>Read a fit result from an XML node</p> 
     272<table class="docutils field-list" frame="void" rules="none"> 
     273<col class="field-name" /> 
     274<col class="field-body" /> 
     275<tbody valign="top"> 
     276<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> &#8211; XML node to read from</td> 
     277</tr> 
     278<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">PageState object</td> 
     279</tr> 
     280</tbody> 
     281</table> 
     282</dd></dl> 
     283 
     284<dl class="method"> 
     285<dt id="sans.guiframe.state_reader.Reader2D._read_cansas"> 
     286<tt class="descname">_read_cansas</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D._read_cansas" title="Permalink to this definition">¶</a></dt> 
     287<dd><p>Load data and P(r) information from a CanSAS XML file.</p> 
     288<table class="docutils field-list" frame="void" rules="none"> 
     289<col class="field-name" /> 
     290<col class="field-body" /> 
     291<tbody valign="top"> 
     292<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
     293</td> 
     294</tr> 
     295<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object if a single SASentry was found,  
     296or a list of Data1D objects if multiple entries were found, 
     297or None of nothing was found</p> 
     298</td> 
     299</tr> 
     300<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
     301<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li> 
     302<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li> 
     303</ul> 
     304</td> 
     305</tr> 
     306</tbody> 
     307</table> 
     308</dd></dl> 
     309 
     310<dl class="method"> 
     311<dt id="sans.guiframe.state_reader.Reader2D._to_xml_doc"> 
     312<tt class="descname">_to_xml_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D._to_xml_doc" title="Permalink to this definition">¶</a></dt> 
     313<dd><p>Create an XML document to contain the content of a Data2D</p> 
     314<table class="docutils field-list" frame="void" rules="none"> 
     315<col class="field-name" /> 
     316<col class="field-body" /> 
     317<tbody valign="top"> 
     318<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> &#8211; Data2D object</td> 
     319</tr> 
     320</tbody> 
     321</table> 
     322</dd></dl> 
     323 
     324<dl class="attribute"> 
     325<dt id="sans.guiframe.state_reader.Reader2D.ext"> 
     326<tt class="descname">ext</tt><em class="property"> = ['.fitv', '.FITV', '.svs', 'SVS']</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.ext" title="Permalink to this definition">¶</a></dt> 
     327<dd></dd></dl> 
     328 
     329<dl class="method"> 
    123330<dt id="sans.guiframe.state_reader.Reader2D.read"> 
    124 <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.read" title="Permalink to this definition">¶</a></dt> 
     331<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.read" title="Permalink to this definition">¶</a></dt> 
    125332<dd><p>Load a new P(r) inversion state from file</p> 
    126333<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    128335<col class="field-body" /> 
    129336<tbody valign="top"> 
    130 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; file path</td> 
    131 </tr> 
    132 </tbody> 
    133 </table> 
    134 </dd></dl> 
     337<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; file path</td> 
     338</tr> 
     339</tbody> 
     340</table> 
     341</dd></dl> 
     342 
     343<dl class="attribute"> 
     344<dt id="sans.guiframe.state_reader.Reader2D.type"> 
     345<tt class="descname">type</tt><em class="property"> = ['Fitting files (*.fitv)|*.fitvSANSView file (*.svs)|*.svs']</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.type" title="Permalink to this definition">¶</a></dt> 
     346<dd></dd></dl> 
     347 
     348<dl class="attribute"> 
     349<dt id="sans.guiframe.state_reader.Reader2D.type_name"> 
     350<tt class="descname">type_name</tt><em class="property"> = 'Fitting'</em><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.type_name" title="Permalink to this definition">¶</a></dt> 
     351<dd></dd></dl> 
    135352 
    136353<dl class="method"> 
    137354<dt id="sans.guiframe.state_reader.Reader2D.write"> 
    138 <tt class="descname">write</tt><big>(</big><em>filename</em>, <em>datainfo=None</em>, <em>fitstate=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.write" title="Permalink to this definition">¶</a></dt> 
     355<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.write" title="Permalink to this definition">¶</a></dt> 
    139356<dd><p>Write the content of a Data1D as a CanSAS XML file only for standalone</p> 
    140357<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    142359<col class="field-body" /> 
    143360<tbody valign="top"> 
    144 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     361<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    145362<li><strong>filename</strong> &#8211; name of the file to write</li> 
    146363<li><strong>datainfo</strong> &#8211; Data1D object</li> 
    … …  
    155372<dl class="method"> 
    156373<dt id="sans.guiframe.state_reader.Reader2D.write_toXML"> 
    157 <tt class="descname">write_toXML</tt><big>(</big><em>datainfo=None</em>, <em>state=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.write_toXML" title="Permalink to this definition">¶</a></dt> 
     374<tt class="descname">write_toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.Reader2D.write_toXML" title="Permalink to this definition">¶</a></dt> 
    158375<dd><p>Write toXML, a helper for write() , could be used by guimanager._on_save()</p> 
    159376<p>: return: xml doc</p> 
    … …  
    164381<dl class="function"> 
    165382<dt id="sans.guiframe.state_reader.get_content"> 
    166 <tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">get_content</tt><big>(</big><em>location</em>, <em>node</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.get_content" title="Permalink to this definition">¶</a></dt> 
     383<tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">get_content</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.get_content" title="Permalink to this definition">¶</a></dt> 
    167384<dd><p>Get the first instance of the content of a xpath location.</p> 
    168385<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    170387<col class="field-body" /> 
    171388<tbody valign="top"> 
    172 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     389<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    173390<li><strong>location</strong> &#8211; xpath location</li> 
    174391<li><strong>node</strong> &#8211; node to start at</li> 
    … …  
    176393</td> 
    177394</tr> 
    178 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Element, or None</p> 
     395<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Element, or None</p> 
    179396</td> 
    180397</tr> 
    … …  
    185402<dl class="function"> 
    186403<dt id="sans.guiframe.state_reader.get_float"> 
    187 <tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">get_float</tt><big>(</big><em>location</em>, <em>node</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.get_float" title="Permalink to this definition">¶</a></dt> 
     404<tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">get_float</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.get_float" title="Permalink to this definition">¶</a></dt> 
    188405<dd><p>Get the content of a node as a float</p> 
    189406<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    191408<col class="field-body" /> 
    192409<tbody valign="top"> 
    193 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     410<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    194411<li><strong>location</strong> &#8211; xpath location</li> 
    195412<li><strong>node</strong> &#8211; node to start at</li> 
    … …  
    203420<dl class="function"> 
    204421<dt id="sans.guiframe.state_reader.write_node"> 
    205 <tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">write_node</tt><big>(</big><em>doc</em>, <em>parent</em>, <em>name</em>, <em>value</em>, <em>attr={}</em><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.write_node" title="Permalink to this definition">¶</a></dt> 
     422<tt class="descclassname">sans.guiframe.state_reader.</tt><tt class="descname">write_node</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.state_reader.write_node" title="Permalink to this definition">¶</a></dt> 
    206423<dd><table class="docutils field-list" frame="void" rules="none"> 
    207424<col class="field-name" /> 
    208425<col class="field-body" /> 
    209426<tbody valign="top"> 
    210 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     427<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    211428<li><strong>doc</strong> &#8211; document DOM</li> 
    212429<li><strong>parent</strong> &#8211; parent node</li> 
    … …  
    217434</td> 
    218435</tr> 
    219 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if something was appended, otherwise False</p> 
     436<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if something was appended, otherwise False</p> 
    220437</td> 
    221438</tr> 
    … …  
    236453  <ul> 
    237454<li><a class="reference internal" href="#">state_reader</a><ul> 
    238 <li><a class="reference internal" href="#module-sans.guiframe.state_reader"><tt class="docutils literal"><span class="pre">sans.guiframe.state_reader</span></tt></a></li> 
     455<li><a class="reference internal" href="#sans-guiframe-state-reader"><tt class="docutils literal"><span class="pre">sans.guiframe.state_reader</span></tt></a></li> 
    239456</ul> 
    240457</li> 
    … …  
    255472  <h3>Quick search</h3> 
    256473    <form class="search" action="../search.html" method="get"> 
    257       <input type="text" name="q" size="18" /> 
     474      <input type="text" name="q" /> 
    258475      <input type="submit" value="Go" /> 
    259476      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    284501          <a href="startup_configuration.html" title="startup_configuration" 
    285502             >previous</a> |</li> 
    286         <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li> 
     503        <li><a href="../index.html">guiframe 0.1.0 documentation</a> &raquo;</li> 
    287504          <li><a href="index.html" >Reference</a> &raquo;</li>  
    288505      </ul> 
    … …  
    290507    <div class="footer"> 
    291508        &copy; Copyright 2010, sans group. 
    292       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     509      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    293510    </div> 
    294511  </body> 
Note: See TracChangeset for help on using the changeset viewer.