source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildreadcmd.html @ 510

Last change on this file since 510 was 402, checked in by smasson, 15 years ago

update documentation
File size: 6.4 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>buildreadcmd.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="buildreadcmd.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//buildreadcmd.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="buildcmd.html">&lt;&lt;prev file</a> | <a href="changefield.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="buildreadcmd.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">buildreadcmd.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_buildreadcmd">
103
104          <h2><a class="top" href="#container">top</a>buildreadcmd </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>buildreadcmd(<span class="result"><a href="#_buildreadcmd_param_base">base</a>, <a href="#_buildreadcmd_param_snameexp">snameexp</a>, <a href="#_buildreadcmd_param_procedure">procedure</a>, <a href="#_buildreadcmd_param_type">type</a></span>, <a href="#_buildreadcmd_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_buildreadcmd_keyword_COMPLETE">COMPLETE</a>=<span class="result">COMPLETE</span>, <a href="#_buildreadcmd_keyword_NAMEFIELD">NAMEFIELD</a>=<span class="result">NAMEFIELD</span>)</p>
108       
109          <div class="comments">
110</div>
111
112         
113
114         
115            <h3>Parameters</h3>
116       
117           
118            <h4 id="_buildreadcmd_param_base">base&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
119              <span class="attr">in</span>
120             
121             
122              <span class="attr">required</span>
123             
124             
125             
126             
127            </h4>
128       
129          <div class="comments">
130 The id of the widget where apply the drawing.
131</div>
132           
133            <h4 id="_buildreadcmd_param_snameexp">snameexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134              <span class="attr">in</span>
135             
136             
137              <span class="attr">required</span>
138             
139             
140             
141             
142            </h4>
143       
144          <div class="comments">
145</div>
146           
147            <h4 id="_buildreadcmd_param_procedure">procedure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148              <span class="attr">in</span>
149             
150             
151              <span class="attr">required</span>
152             
153             
154             
155             
156            </h4>
157       
158          <div class="comments">
159</div>
160           
161            <h4 id="_buildreadcmd_param_type">type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162              <span class="attr">in</span>
163             
164             
165              <span class="attr">required</span>
166             
167             
168             
169             
170            </h4>
171       
172          <div class="comments">
173</div>
174           
175
176         
177
178         
179
180            <h3>Keywords</h3>
181           
182            <h4 id="_buildreadcmd_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184             
185             
186             
187             
188             
189             
190             
191            </h4>
192       
193            <div class="comments">
194 Vector indicating the geographic zone on which we want to cut the map.
195 If BOXZOOM has :
196   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
197   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
198   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
199   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
200   6 elements: The extraction is made on Boxzoom
201 Where lon1, lon2,lat1,lat2 are global variables defined at the last
202 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
203</div>
204           
205            <h4 id="_buildreadcmd_keyword_COMPLETE">COMPLETE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207             
208             
209             
210             
211             
212             
213             
214            </h4>
215       
216            <div class="comments">
217</div>
218           
219            <h4 id="_buildreadcmd_keyword_NAMEFIELD">NAMEFIELD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226             
227             
228            </h4>
229       
230            <div class="comments">
231</div>
232           
233         
234
235         
236          <h3>Version history</h3>
237         
238          <h4>Version</h4><div class="preformat">
239 $Id: buildreadcmd.pro 370 2008-08-07 07:59:15Z pinsard $
240</div>
241          <h4>History</h4><div class="preformat">
242 Sebastien Masson (smasson@lodyc.jussieu.fr)
243</div>
244         
245         
246          <h3>Known issues</h3>
247         
248         
249          <h4>Todo items</h4><div class="preformat">
250 seb: documenter les param et les keyword qui ne le sont pas.
251</div>
252         
253       
254          <h3>Other attributes</h3>
255         
256         
257          <h4>Uses routines</h4><div class="preformat">
258 <a href="../../..//Obsolete/common.html">common</a>
259</div>
260         
261         
262         
263       
264          <h3>Statistics</h3>
265          <table class="statistics">
266            <tr><td>McCabe cyclic</td><td>          24</td></tr>
267            <tr><td>McCabe essential</td><td>           1</td></tr>
268            <tr><td>McCabe modular design</td><td>           1</td></tr>
269          </table>
270         
271       
272        </div>
273       
274      </div>
275
276     
277
278      <div id="tagline">Produced by IDLdoc 2.0.</div>
279
280    </div>
281
282  </body>
283</html>
Note: See TracBrowser for help on using the repository browser.