File: api-ahven-parameters.html

package info (click to toggle)
ahven 2.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,724 kB
  • sloc: ada: 3,928; makefile: 259; xml: 108; sh: 57; python: 25; perl: 7
file content (220 lines) | stat: -rw-r--r-- 9,861 bytes parent folder | download
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

<!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>Ahven.Parameters – Package &mdash; Ahven 2.1 documentation</title>
    
    <link rel="stylesheet" href="_static/nature.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.1',
        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>
    <link rel="top" title="Ahven 2.1 documentation" href="index.html" />
    <link rel="up" title="API Documentation for Ahven" href="api.html" />
    <link rel="next" title="Ahven.Results – Package" href="api-ahven-results.html" />
    <link rel="prev" title="Ahven.Listeners – Package" href="api-ahven-listeners.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="ada-modindex.html" title="Ada Module Index"
             >Ada modules</a> |</li>
        <li class="right" >
          <a href="api-ahven-results.html" title="Ahven.Results – Package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="api-ahven-listeners.html" title="Ahven.Listeners – Package"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Ahven 2.1 documentation</a> &raquo;</li>
          <li><a href="api.html" accesskey="U">API Documentation for Ahven</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-Ahven.Parameters">
<span id="ahven-parameters-package"></span><h1><a class="reference internal" href="#module-Ahven.Parameters" title="Ahven.Parameters"><tt class="xref py py-mod docutils literal"><span class="pre">Ahven.Parameters</span></tt></a> &#8211; Package<a class="headerlink" href="#module-Ahven.Parameters" title="Permalink to this headline">¶</a></h1>
<div class="section" id="types">
<h2>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h2>
<div class="section" id="parameter-info">
<h3>Parameter_Info<a class="headerlink" href="#parameter-info" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>type Parameter_Info is private;</pre>
</div>
</div>
<div class="section" id="parameter-mode">
<h3>Parameter_Mode<a class="headerlink" href="#parameter-mode" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>type Parameter_Mode is (NORMAL_PARAMETERS, TAP_PARAMETERS);</pre>
</div>
</div>
</div>
<div class="section" id="procedures-and-functions">
<h2>Procedures and Functions<a class="headerlink" href="#procedures-and-functions" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><dl class="docutils">
<dt>procedure Parse_Parameters (Mode <span class="classifier-delimiter">:</span> <span class="classifier">Parameter_Mode;</span></dt>
<dd>Info : out Parameter_Info);</dd>
</dl>
</div></blockquote>
<p>Parse Ada.Command_Line parameters and put the results
to the Info parameter. Raises Invalid_Parameter if
some parameter is invalid.</p>
<div class="section" id="parse-parameters">
<h3>Parse_Parameters<a class="headerlink" href="#parse-parameters" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>procedure Parse_Parameters (Mode :     Parameter_Mode;
                            Info : out Parameter_Info);</pre>
</div>
<p>Parse Ada.Command_Line parameters and put the results
to the Info parameter. Raises Invalid_Parameter if
some parameter is invalid.</p>
</div>
<div class="section" id="usage">
<h3>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>procedure Usage (Mode : Parameter_Mode := NORMAL_PARAMETERS);</pre>
</div>
<p>Print usage.</p>
</div>
<div class="section" id="capture">
<h3>Capture<a class="headerlink" href="#capture" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>function Capture (Info : Parameter_Info) return Boolean;</pre>
</div>
<p>Capture Ada.Text_IO output?</p>
</div>
<div class="section" id="verbose">
<h3>Verbose<a class="headerlink" href="#verbose" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>function Verbose (Info : Parameter_Info) return Boolean;</pre>
</div>
<p>Use verbose mode?</p>
</div>
<div class="section" id="xml-results">
<h3>XML_Results<a class="headerlink" href="#xml-results" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>function XML_Results (Info : Parameter_Info) return Boolean;</pre>
</div>
<p>Output XML?</p>
</div>
<div class="section" id="single-test">
<h3>Single_Test<a class="headerlink" href="#single-test" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>function Single_Test (Info : Parameter_Info) return Boolean;</pre>
</div>
<p>Run a single test (case/suite/routine) only?</p>
</div>
<div class="section" id="test-name">
<h3>Test_Name<a class="headerlink" href="#test-name" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>function Test_Name (Info : Parameter_Info) return String;</pre>
</div>
<p>Return the name of the test passed as a parameter.</p>
</div>
<div class="section" id="result-dir">
<h3>Result_Dir<a class="headerlink" href="#result-dir" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><pre>function Result_Dir (Info : Parameter_Info) return String;</pre>
</div>
<p>Return the directory for XML results.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#"><tt class="docutils literal"><span class="pre">Ahven.Parameters</span></tt> &#8211; Package</a><ul>
<li><a class="reference internal" href="#types">Types</a><ul>
<li><a class="reference internal" href="#parameter-info">Parameter_Info</a></li>
<li><a class="reference internal" href="#parameter-mode">Parameter_Mode</a></li>
</ul>
</li>
<li><a class="reference internal" href="#procedures-and-functions">Procedures and Functions</a><ul>
<li><a class="reference internal" href="#parse-parameters">Parse_Parameters</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#capture">Capture</a></li>
<li><a class="reference internal" href="#verbose">Verbose</a></li>
<li><a class="reference internal" href="#xml-results">XML_Results</a></li>
<li><a class="reference internal" href="#single-test">Single_Test</a></li>
<li><a class="reference internal" href="#test-name">Test_Name</a></li>
<li><a class="reference internal" href="#result-dir">Result_Dir</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="api-ahven-listeners.html"
                        title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">Ahven.Listeners</span></tt> &#8211; Package</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="api-ahven-results.html"
                        title="next chapter"><tt class="docutils literal"><span class="pre">Ahven.Results</span></tt> &#8211; Package</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/api-ahven-parameters.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <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="ada-modindex.html" title="Ada Module Index"
             >Ada modules</a> |</li>
        <li class="right" >
          <a href="api-ahven-results.html" title="Ahven.Results – Package"
             >next</a> |</li>
        <li class="right" >
          <a href="api-ahven-listeners.html" title="Ahven.Listeners – Package"
             >previous</a> |</li>
        <li><a href="index.html">Ahven 2.1 documentation</a> &raquo;</li>
          <li><a href="api.html" >API Documentation for Ahven</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, Tero Koskinen.
      Last updated on Sep 24, 2011.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre.
    </div>
  </body>
</html>