source: sasview/sansdataloader/docs/sphinx/html/api/readers/associations.html @ 70ecd530

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 70ecd530 was 7247844, checked in by Gervaise Alina <gervyh@…>, 13 years ago

updates docs
  • 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>associations &mdash; DataLoader 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../../_static/jquery.js"></script>
26    <script type="text/javascript" src="../../_static/underscore.js"></script>
27    <script type="text/javascript" src="../../_static/doctools.js"></script>
28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../../index.html" />
29    <link rel="up" title="Readers" href="index.html" />
30    <link rel="next" title="cansas_reader" href="cansas_reader.html" />
31    <link rel="prev" title="ascii_reader" href="ascii_reader.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="cansas_reader.html" title="cansas_reader"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="ascii_reader.html" title="ascii_reader"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Readers</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="associations">
60<h1>associations<a class="headerlink" href="#associations" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-dataloader-readers-associations">
62<h2><a class="reference internal" href="#module-sans.dataloader.readers.associations" title="sans.dataloader.readers.associations"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-associations" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.dataloader.readers.associations"></span><p>Module to associate default readers to file extensions.
64The module reads an xml file to get the readers for each file extension.
65The readers are tried in order they appear when reading a file.</p>
66<dl class="function">
67<dt id="sans.dataloader.readers.associations.read_associations">
68<tt class="descclassname">sans.dataloader.readers.associations.</tt><tt class="descname">read_associations</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.associations.read_associations" title="Permalink to this definition">¶</a></dt>
69<dd><p>Read the specified settings file to associate
70default readers to file extension.</p>
71<table class="docutils field-list" frame="void" rules="none">
72<col class="field-name" />
73<col class="field-body" />
74<tbody valign="top">
75<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
76<li><strong>loader</strong> &#8211; Loader object</li>
77<li><strong>settings</strong> &#8211; path to the XML settings file [string]</li>
78</ul>
79</td>
80</tr>
81</tbody>
82</table>
83</dd></dl>
84
85<dl class="function">
86<dt id="sans.dataloader.readers.associations.register_readers">
87<tt class="descclassname">sans.dataloader.readers.associations.</tt><tt class="descname">register_readers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.associations.register_readers" title="Permalink to this definition">¶</a></dt>
88<dd><p>Function called by the registry/loader object to register
89all default readers using a call back function.</p>
90<table class="docutils field-list" frame="void" rules="none">
91<col class="field-name" />
92<col class="field-body" />
93<tbody valign="top">
94<tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">this method is now obsolete</td>
95</tr>
96<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><strong>registry_function</strong> &#8211; function to be called to register each reader</td>
97</tr>
98</tbody>
99</table>
100</dd></dl>
101
102</div>
103</div>
104
105
106          </div>
107        </div>
108      </div>
109      <div class="sphinxsidebar">
110        <div class="sphinxsidebarwrapper">
111  <h3><a href="../../index.html">Table Of Contents</a></h3>
112  <ul>
113<li><a class="reference internal" href="#">associations</a><ul>
114<li><a class="reference internal" href="#sans-dataloader-readers-associations"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a></li>
115</ul>
116</li>
117</ul>
118
119  <h4>Previous topic</h4>
120  <p class="topless"><a href="ascii_reader.html"
121                        title="previous chapter">ascii_reader</a></p>
122  <h4>Next topic</h4>
123  <p class="topless"><a href="cansas_reader.html"
124                        title="next chapter">cansas_reader</a></p>
125  <h3>This Page</h3>
126  <ul class="this-page-menu">
127    <li><a href="../../_sources/api/readers/associations.txt"
128           rel="nofollow">Show Source</a></li>
129  </ul>
130<div id="searchbox" style="display: none">
131  <h3>Quick search</h3>
132    <form class="search" action="../../search.html" method="get">
133      <input type="text" name="q" />
134      <input type="submit" value="Go" />
135      <input type="hidden" name="check_keywords" value="yes" />
136      <input type="hidden" name="area" value="default" />
137    </form>
138    <p class="searchtip" style="font-size: 90%">
139    Enter search terms or a module, class or function name.
140    </p>
141</div>
142<script type="text/javascript">$('#searchbox').show(0);</script>
143        </div>
144      </div>
145      <div class="clearer"></div>
146    </div>
147    <div class="related">
148      <h3>Navigation</h3>
149      <ul>
150        <li class="right" style="margin-right: 10px">
151          <a href="../../genindex.html" title="General Index"
152             >index</a></li>
153        <li class="right" >
154          <a href="../../py-modindex.html" title="Python Module Index"
155             >modules</a> |</li>
156        <li class="right" >
157          <a href="cansas_reader.html" title="cansas_reader"
158             >next</a> |</li>
159        <li class="right" >
160          <a href="ascii_reader.html" title="ascii_reader"
161             >previous</a> |</li>
162        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
163          <li><a href="index.html" >Readers</a> &raquo;</li> 
164      </ul>
165    </div>
166    <div class="footer">
167        &copy; Copyright 2010, sans group.
168      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
169    </div>
170  </body>
171</html>
Note: See TracBrowser for help on using the repository browser.