source: sasview/sansmodels/docs/sphinx/_build/html/api/ModelFactory.html @ 79ac6f8

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

working on documentation
  • Property mode set to 100644
File size: 6.4 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>ModelFactory &mdash; sansmodels 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="sansmodels v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="ModelIO" href="ModelIO.html" />
28    <link rel="prev" title="ModelAdaptor" href="ModelAdaptor.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="ModelIO.html" title="ModelIO"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="ModelAdaptor.html" title="ModelAdaptor"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">sansmodels 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="modelfactory">
57<h1>ModelFactory<a class="headerlink" href="#modelfactory" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.ModelFactory">
59<span id="sans-models-modelfactory"></span><h2><a class="reference internal" href="#module-sans.models.ModelFactory"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ModelFactory</span></tt></a><a class="headerlink" href="#module-sans.models.ModelFactory" title="Permalink to this headline">¶</a></h2>
60<p>Model factory
61Class that creates models by looking up the name of a model
62in the models directory</p>
63<p>&#64;author: Mathieu Doucet / UTK
64&#64;contact: <a class="reference external" href="mailto:mathieu&#46;doucet&#37;&#52;&#48;nist&#46;gov">mathieu<span>&#46;</span>doucet<span>&#64;</span>nist<span>&#46;</span>gov</a></p>
65<dl class="class">
66<dt id="sans.models.ModelFactory.ModelFactory">
67<em class="property">class </em><tt class="descclassname">sans.models.ModelFactory.</tt><tt class="descname">ModelFactory</tt><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory" title="Permalink to this definition">¶</a></dt>
68<dd><p>Class to create available models</p>
69<dl class="method">
70<dt id="sans.models.ModelFactory.ModelFactory.getAllModels">
71<tt class="descname">getAllModels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory.getAllModels" title="Permalink to this definition">¶</a></dt>
72<dd>Returns a list of all available models
73&#64;return: python list object</dd></dl>
74
75<dl class="method">
76<dt id="sans.models.ModelFactory.ModelFactory.getModel">
77<tt class="descname">getModel</tt><big>(</big><em>name='BaseComponent'</em><big>)</big><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory.getModel" title="Permalink to this definition">¶</a></dt>
78<dd>Returns the model if found
79&#64;param name: name of the model to look for
80&#64;return: the model object</dd></dl>
81
82</dd></dl>
83
84</div>
85</div>
86
87
88          </div>
89        </div>
90      </div>
91      <div class="sphinxsidebar">
92        <div class="sphinxsidebarwrapper">
93  <h3><a href="../index.html">Table Of Contents</a></h3>
94  <ul>
95<li><a class="reference internal" href="#">ModelFactory</a><ul>
96<li><a class="reference internal" href="#module-sans.models.ModelFactory"><tt class="docutils literal"><span class="pre">sans.models.ModelFactory</span></tt></a></li>
97</ul>
98</li>
99</ul>
100
101  <h4>Previous topic</h4>
102  <p class="topless"><a href="ModelAdaptor.html"
103                        title="previous chapter">ModelAdaptor</a></p>
104  <h4>Next topic</h4>
105  <p class="topless"><a href="ModelIO.html"
106                        title="next chapter">ModelIO</a></p>
107  <h3>This Page</h3>
108  <ul class="this-page-menu">
109    <li><a href="../_sources/api/ModelFactory.txt"
110           rel="nofollow">Show Source</a></li>
111  </ul>
112<div id="searchbox" style="display: none">
113  <h3>Quick search</h3>
114    <form class="search" action="../search.html" method="get">
115      <input type="text" name="q" size="18" />
116      <input type="submit" value="Go" />
117      <input type="hidden" name="check_keywords" value="yes" />
118      <input type="hidden" name="area" value="default" />
119    </form>
120    <p class="searchtip" style="font-size: 90%">
121    Enter search terms or a module, class or function name.
122    </p>
123</div>
124<script type="text/javascript">$('#searchbox').show(0);</script>
125        </div>
126      </div>
127      <div class="clearer"></div>
128    </div>
129    <div class="related">
130      <h3>Navigation</h3>
131      <ul>
132        <li class="right" style="margin-right: 10px">
133          <a href="../genindex.html" title="General Index"
134             >index</a></li>
135        <li class="right" >
136          <a href="../py-modindex.html" title="Python Module Index"
137             >modules</a> |</li>
138        <li class="right" >
139          <a href="ModelIO.html" title="ModelIO"
140             >next</a> |</li>
141        <li class="right" >
142          <a href="ModelAdaptor.html" title="ModelAdaptor"
143             >previous</a> |</li>
144        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
145          <li><a href="index.html" >Reference</a> &raquo;</li> 
146      </ul>
147    </div>
148    <div class="footer">
149        &copy; Copyright 2010, sans group.
150      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
151    </div>
152  </body>
153</html>
Note: See TracBrowser for help on using the repository browser.