source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/read_vermair.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.2 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>read_vermair.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="read_vermair.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../../ToBeReviewed/WIDGET/AUTOUR_de_XXX//read_vermair.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="longclickaction.html">&lt;&lt;prev file</a> | <a href="scanfile.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="read_vermair.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/AUTOUR_de_XXX/</a></h1>
82      <h2 class="pro_file">read_vermair.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_read_vermair">
104
105          <h2><a class="top" href="#container">top</a>read_vermair <span class="categories">
106</span></h2>
107       
108          <p class="header">
109            <span class="result">result = </span>read_vermair(<span class="result"><a href="#_read_vermair_param_name">name</a>, <a href="#_read_vermair_param_debut">debut</a>, <a href="#_read_vermair_param_fin">fin</a>, <a href="#_read_vermair_param_nomexp">nomexp</a></span>, <a href="#_read_vermair_keyword_PARENT">PARENT</a>=<span class="result">PARENT</span>, <a href="#_read_vermair_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_vermair_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
110       
111          <div class="comments">
112</div>
113
114          <h3>Return value</h3><div class="preformat">
115</div>
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_read_vermair_param_name">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122             
123             
124             
125             
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments">
133</div>
134           
135            <h4 id="_read_vermair_param_debut">debut&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136             
137             
138             
139             
140             
141             
142             
143             
144            </h4>
145       
146          <div class="comments">
147</div>
148           
149            <h4 id="_read_vermair_param_fin">fin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
160          <div class="comments">
161</div>
162           
163            <h4 id="_read_vermair_param_nomexp">nomexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174          <div class="comments">
175</div>
176           
177
178         
179
180         
181
182            <h3>Keywords</h3>
183           
184            <h4 id="_read_vermair_keyword_PARENT">PARENT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185             
186             
187             
188             
189             
190             
191             
192             
193            </h4>
194       
195            <div class="comments">
196 same as DIALOG_PARENT de dialog_message.pro
197</div>
198           
199            <h4 id="_read_vermair_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200             
201             
202             
203             
204             
205             
206             
207             
208            </h4>
209       
210            <div class="comments">
211 Vector indicating the geographic zone on which we want to cut the map.
212 If BOXZOOM has :
213   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
214   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
215   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
216   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
217   6 elements: The extraction is made on Boxzoom
218 Where lon1, lon2,lat1,lat2 are global variables defined at the last
219 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
220</div>
221           
222            <h4 id="_read_vermair_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226             
227             
228             
229             
230             
231            </h4>
232       
233            <div class="comments">
234 Used to pass keywords
235</div>
236           
237         
238
239          <h3>Examples</h3><div class="preformat">
240</div>
241          <h3>Version history</h3>
242         
243          <h4>Version</h4><div class="preformat">
244 $Id: read_vermair.pro 327 2007-12-13 16:22:35Z pinsard $
245</div>
246          <h4>History</h4><div class="preformat">
247</div>
248         
249         
250          <h3>Known issues</h3>
251         
252         
253          <h4>Todo items</h4><div class="preformat">
254 seb
255</div>
256          <h4>Restrictions</h4><div class="preformat">
257</div>
258       
259          <h3>Other attributes</h3>
260         
261         
262          <h4>Uses routines</h4><div class="preformat">
263</div>
264         
265         
266         
267       
268          <h3>Statistics</h3>
269          <table class="statistics">
270            <tr><td>McCabe cyclic</td><td>           4</td></tr>
271            <tr><td>McCabe essential</td><td>           1</td></tr>
272            <tr><td>McCabe modular design</td><td>           1</td></tr>
273          </table>
274         
275       
276        </div>
277       
278      </div>
279
280     
281
282      <div id="tagline">Produced by IDLdoc 2.0.</div>
283
284    </div>
285
286  </body>
287</html>
Note: See TracBrowser for help on using the repository browser.