source: sasview/DataLoader/docs/sphinx/_build/html/api/readers/associations.html @ a45622a

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

working on documentation
  • Property mode set to 100644
File size: 7.2 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<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>associations &mdash; DataLoader 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="DataLoader v0.1.0 documentation" href="../../index.html" />
26    <link rel="up" title="Readers" href="index.html" />
27    <link rel="next" title="cansas_reader" href="cansas_reader.html" />
28    <link rel="prev" title="ascii_reader" href="ascii_reader.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="cansas_reader.html" title="cansas_reader"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="ascii_reader.html" title="ascii_reader"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Readers</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="associations">
57<h1>associations<a class="headerlink" href="#associations" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-DataLoader.readers.associations">
59<span id="dataloader-readers-associations"></span><h2><a class="reference internal" href="#module-DataLoader.readers.associations"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.associations" title="Permalink to this headline">¶</a></h2>
60<p>Module to associate default readers to file extensions.
61The module reads an xml file to get the readers for each file extension.
62The readers are tried in order they appear when reading a file.</p>
63<dl class="function">
64<dt id="DataLoader.readers.associations.read_associations">
65<tt class="descclassname">DataLoader.readers.associations.</tt><tt class="descname">read_associations</tt><big>(</big><em>loader</em>, <em>settings='defaults.xml'</em><big>)</big><a class="headerlink" href="#DataLoader.readers.associations.read_associations" title="Permalink to this definition">¶</a></dt>
66<dd><p>Read the specified settings file to associate
67default readers to file extension.</p>
68<table class="docutils field-list" frame="void" rules="none">
69<col class="field-name" />
70<col class="field-body" />
71<tbody valign="top">
72<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
73<li><strong>loader</strong> &#8211; Loader object</li>
74<li><strong>settings</strong> &#8211; path to the XML settings file [string]</li>
75</ul>
76</td>
77</tr>
78</tbody>
79</table>
80</dd></dl>
81
82<dl class="function">
83<dt id="DataLoader.readers.associations.register_readers">
84<tt class="descclassname">DataLoader.readers.associations.</tt><tt class="descname">register_readers</tt><big>(</big><em>registry_function</em><big>)</big><a class="headerlink" href="#DataLoader.readers.associations.register_readers" title="Permalink to this definition">¶</a></dt>
85<dd><p>Function called by the registry/loader object to register
86all default readers using a call back function.</p>
87<table class="docutils field-list" frame="void" rules="none">
88<col class="field-name" />
89<col class="field-body" />
90<tbody valign="top">
91<tr class="field"><th class="field-name">Warning :</th><td class="field-body"><p class="first">this method is now obsolete</p>
92</td>
93</tr>
94<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
95<li><strong>registry_function</strong> &#8211; function to be called to register each reader</li>
96</ul>
97</td>
98</tr>
99</tbody>
100</table>
101</dd></dl>
102
103</div>
104</div>
105
106
107          </div>
108        </div>
109      </div>
110      <div class="sphinxsidebar">
111        <div class="sphinxsidebarwrapper">
112  <h3><a href="../../index.html">Table Of Contents</a></h3>
113  <ul>
114<li><a class="reference internal" href="#">associations</a><ul>
115<li><a class="reference internal" href="#module-DataLoader.readers.associations"><tt class="docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a></li>
116</ul>
117</li>
118</ul>
119
120  <h4>Previous topic</h4>
121  <p class="topless"><a href="ascii_reader.html"
122                        title="previous chapter">ascii_reader</a></p>
123  <h4>Next topic</h4>
124  <p class="topless"><a href="cansas_reader.html"
125                        title="next chapter">cansas_reader</a></p>
126  <h3>This Page</h3>
127  <ul class="this-page-menu">
128    <li><a href="../../_sources/api/readers/associations.txt"
129           rel="nofollow">Show Source</a></li>
130  </ul>
131<div id="searchbox" style="display: none">
132  <h3>Quick search</h3>
133    <form class="search" action="../../search.html" method="get">
134      <input type="text" name="q" size="18" />
135      <input type="submit" value="Go" />
136      <input type="hidden" name="check_keywords" value="yes" />
137      <input type="hidden" name="area" value="default" />
138    </form>
139    <p class="searchtip" style="font-size: 90%">
140    Enter search terms or a module, class or function name.
141    </p>
142</div>
143<script type="text/javascript">$('#searchbox').show(0);</script>
144        </div>
145      </div>
146      <div class="clearer"></div>
147    </div>
148    <div class="related">
149      <h3>Navigation</h3>
150      <ul>
151        <li class="right" style="margin-right: 10px">
152          <a href="../../genindex.html" title="General Index"
153             >index</a></li>
154        <li class="right" >
155          <a href="../../py-modindex.html" title="Python Module Index"
156             >modules</a> |</li>
157        <li class="right" >
158          <a href="cansas_reader.html" title="cansas_reader"
159             >next</a> |</li>
160        <li class="right" >
161          <a href="ascii_reader.html" title="ascii_reader"
162             >previous</a> |</li>
163        <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
164          <li><a href="index.html" >Readers</a> &raquo;</li> 
165      </ul>
166    </div>
167    <div class="footer">
168        &copy; Copyright 2010, sans group.
169      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
170    </div>
171  </body>
172</html>
Note: See TracBrowser for help on using the repository browser.