File: reference_schema.html

package info (click to toggle)
xmds2 2.2.2%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 53,384 kB
  • ctags: 7,223
  • sloc: python: 54,076; cpp: 3,929; ansic: 1,463; makefile: 135; sh: 20
file content (254 lines) | stat: -rw-r--r-- 21,353 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>XMDS2 XML Schema &mdash; XMDS2 2.2.2 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '2.2.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML,http://www.xmds.org/_static/mathjax-use-tex-fonts.js"></script>
    <link rel="shortcut icon" href="_static/xmds_favicon.ico"/>
    <link rel="top" title="XMDS2 2.2.2 documentation" href="index.html" />
    <link rel="up" title="Reference section" href="reference_index.html" />
    <link rel="next" title="XMDS2 script elements" href="reference_elements.html" />
    <link rel="prev" title="Useful XML Syntax" href="reference_usefulXMLSyntax.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="reference_elements.html" title="XMDS2 script elements"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="reference_usefulXMLSyntax.html" title="Useful XML Syntax"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">XMDS2 2.2.2 documentation</a> &raquo;</li>
          <li><a href="reference_index.html" accesskey="U">Reference section</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="xmds2-xml-schema">
<span id="referenceschema"></span><span id="index-0"></span><h1>XMDS2 XML Schema<a class="headerlink" href="#xmds2-xml-schema" title="Permalink to this headline">ΒΆ</a></h1>
<p>There are many, many XML tags that can make up an XMDS2 script. Most of them are optional, or have default values if not specified. It is, however, useful to know which elements are possible, and their position and relationship to other elements in the script. Shown below is the full XML tree for XMDS2, which shows all possible elements and their position in the tree. An ellipsis (...) outside an element indicates the element above can be repeated indefinitely, and an ellipsis inside an element (&lt;element&gt; ... &lt;/element&gt;) indicates that the structure of that element has already been shown previously.</p>
<p>The syntax &lt;element /&gt; can be used for lowest-level elements that have attributes but no content, and are shorthand for &lt;element&gt; &lt;/element&gt;. This shorthand notation can also be used for elements which can only contain the content &#8220;yes&#8221; or &#8220;no&#8221;; in this case the presence of &lt;element /&gt; is equivalent to &lt;element&gt; yes &lt;/element&gt;, and the absence of such an element is equivalent to &lt;element&gt; no &lt;/element&gt;</p>
<p>The possible attributes and attribute values for each element are not shown; see the individual entries in the Reference section for details.</p>
<pre class="literal-block">
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;<a class="reference internal" href="reference_elements.html#simulationelement"><em>simulation</em></a> xmds-version=&quot;2&quot;&gt;
  &lt;<a class="reference internal" href="reference_elements.html#nameelement"><em>name</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#nameelement"><em>/name</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#authorelement"><em>author</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#authorelement"><em>author</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#descriptionelement"><em>description</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#descriptionelement"><em>/description</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#featureselement"><em>features</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#argumentselement"><em>arguments</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#argumentelement"><em>argument</em></a> /&gt;
      &lt;<a class="reference internal" href="reference_elements.html#argumentelement"><em>argument</em></a> /&gt;
      ...
    &lt;<a class="reference internal" href="reference_elements.html#argumentselement"><em>/arguments</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#autovectorise"><em>auto_vectorise</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#benchmark"><em>benchmark</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#bing"><em>bing</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#cflags"><em>cflags</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#cflags"><em>/cflags</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#chunkedoutput"><em>chunked_output</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#diagnostics"><em>diagnostics</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#errorcheck"><em>error_check</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#haltnonfinite"><em>halt_non_finite</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#fftw"><em>fftw</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#globals"><em>globals</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#globals"><em>/globals</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#openmp"><em>openmp</em></a> /&gt;
    &lt;<a class="reference internal" href="reference_elements.html#precision"><em>precision</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#precision"><em>/precision</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#validation"><em>validation</em></a> /&gt;
  &lt;<a class="reference internal" href="reference_elements.html#featureselement"><em>/features</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#driverelement"><em>driver</em></a> /&gt;

  &lt;<a class="reference internal" href="reference_elements.html#geometryelement"><em>geometry</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#propagationdimensionelement"><em>propagation_dimension</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#propagationdimensionelement"><em>/propagation_dimension</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#transversedimensionselement"><em>transverse_dimensions</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dimensionelement"><em>dimension</em></a> /&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dimensionelement"><em>dimension</em></a> /&gt;
      ...
    &lt;<a class="reference internal" href="reference_elements.html#transversedimensionselement"><em>/transverse_dimensions</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#geometryelement"><em>/geometry</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#vectorelement"><em>vector</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#componentselement"><em>components</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#componentselement"><em>/components</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#initialisationelement"><em>initialisation</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#filenameelement"><em>filename</em></a>&gt;
      &lt;![<a class="reference internal" href="reference_elements.html#initialisationelement"><em>CDATA</em></a> [
      ]]&gt;
    &lt;<a class="reference internal" href="reference_elements.html#initialisationelement"><em>/initialisation</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#vectorelement"><em>/vector</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#vectorelement"><em>vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#vectorelement"><em>/vector</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#vectorelement"><em>vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#vectorelement"><em>/vector</em></a>&gt;
  ...

  &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>computed_vector</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#componentselement"><em>components</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#componentselement"><em>/components</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#evaluationelement"><em>evaluation</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
      &lt;![<a class="reference internal" href="reference_elements.html#initialisationelement"><em>CDATA</em></a> [
      ]]&gt;
    &lt;<a class="reference internal" href="reference_elements.html#evaluationelement"><em>/evaluation</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>/computed_vector</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>computed_vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>/computed_vector</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>computed_vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>/computed_vector</em></a>&gt;
  ...

  &lt;<a class="reference internal" href="reference_elements.html#noisevectorelement"><em>noise_vector</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#componentselement"><em>components</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#componentselement"><em>/components</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#noisevectorelement"><em>/noise_vector</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#noisevectorelement"><em>noise_vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#noisevectorelement"><em>/noise_vector</em></a>&gt;
  &lt;<a class="reference internal" href="reference_elements.html#noisevectorelement"><em>noise_vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#noisevectorelement"><em>/noise_vector</em></a>&gt;
  ...

  &lt;<a class="reference internal" href="reference_elements.html#sequenceelement"><em>sequence</em></a>&gt;

    &lt;<a class="reference internal" href="reference_elements.html#filterelement"><em>filter</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
      &lt;![<a class="reference internal" href="reference_elements.html#xmdscsyntax"><em>CDATA</em></a> [
      ]]&gt;
    &lt;<a class="reference internal" href="reference_elements.html#filterelement"><em>/filter</em></a>&gt;

    &lt;<a class="reference internal" href="reference_elements.html#integrateelement"><em>integrate</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#sampleselement"><em>samples</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#sampleselement"><em>/samples</em></a>&gt;

      &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>computed_vector</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#computedvectorelement"><em>/computed_vector</em></a>&gt;

      &lt;<a class="reference internal" href="reference_elements.html#filterselement"><em>filters</em></a>&gt;
        &lt;<a class="reference internal" href="reference_elements.html#filterelement"><em>filter</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#filterelement"><em>/filter</em></a>&gt;
        &lt;<a class="reference internal" href="reference_elements.html#filterelement"><em>filter</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#filterelement"><em>/filter</em></a>&gt;
        ...
      &lt;<a class="reference internal" href="reference_elements.html#filterselement"><em>/filters</em></a>&gt;

      &lt;<a class="reference internal" href="reference_elements.html#operatorselement"><em>operators</em></a>&gt;

        &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>operator</em></a>&gt;
          &lt;<a class="reference internal" href="reference_elements.html#boundaryconditionelement"><em>boundary_condition</em></a>&gt;
            &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
            &lt;![<a class="reference internal" href="reference_elements.html#xmdscsyntax"><em>CDATA</em></a> [
            ]]&gt;
          &lt;<a class="reference internal" href="reference_elements.html#boundaryconditionelement"><em>/boundary_condition</em></a>&gt;
          &lt;<a class="reference internal" href="reference_elements.html#operatornameselement"><em>operator_names</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#operatornameselement"><em>/operator_names</em></a>&gt;
          &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
          &lt;![<a class="reference internal" href="reference_elements.html#xmdscsyntax"><em>CDATA</em></a> [
          ]]&gt;
        &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>/operator</em></a>&gt;

        &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>operator</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>/operator</em></a>&gt;
        &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>operator</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>/operator</em></a>&gt;
        ...

        &lt;<a class="reference internal" href="reference_elements.html#integrationvectorselement"><em>integration_vectors</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#integrationvectorselement"><em>/integration_vectors</em></a>&gt;
        &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
        &lt;![<a class="reference internal" href="reference_elements.html#xmdscsyntax"><em>CDATA</em></a> [
        ]]&gt;

      &lt;<a class="reference internal" href="reference_elements.html#operatorselement"><em>/operators</em></a>&gt;

    &lt;<a class="reference internal" href="reference_elements.html#integrateelement"><em>/integrate</em></a>&gt;

    &lt;<a class="reference internal" href="reference_elements.html#breakpointelement"><em>breakpoint</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#breakpointelement"><em>/breakpoint</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#sequenceelement"><em>/sequence</em></a>&gt;

  &lt;<a class="reference internal" href="reference_elements.html#outputelement"><em>output</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>sampling_group</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>dependencies</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#dependencies"><em>/dependencies</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>moments</em></a>&gt; &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>/moments</em></a>&gt;
      &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>operator</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#operatorelement"><em>/operator</em></a>&gt;
      &lt;![<a class="reference internal" href="reference_elements.html#xmdscsyntax"><em>CDATA</em></a> [
      ]]&gt;
    &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>/sampling_group</em></a>&gt;

    &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>sampling_group</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>/sampling_group</em></a>&gt;
    &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>sampling_group</em></a>&gt; ... &lt;<a class="reference internal" href="reference_elements.html#samplinggroupelement"><em>/sampling_group</em></a>&gt;
    ...

  &lt;<a class="reference internal" href="reference_elements.html#outputelement"><em>/output</em></a>&gt;

&lt;<a class="reference internal" href="reference_elements.html#simulationelement"><em>/simulation</em></a>&gt;
</pre>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/xmds_logo.png" alt="Logo"/>
            </a></p>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="reference_elements.html" title="XMDS2 script elements"
             >next</a> |</li>
        <li class="right" >
          <a href="reference_usefulXMLSyntax.html" title="Useful XML Syntax"
             >previous</a> |</li>
        <li><a href="index.html">XMDS2 2.2.2 documentation</a> &raquo;</li>
          <li><a href="reference_index.html" >Reference section</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2008-2014, Graham Dennis, Joe Hope and Mattias Johnsson. Licensed under the GNU FDL.
      Last updated on Oct 14, 2014.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
    </div>
  </body>
</html>