source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildreadcmd.html @ 402

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

update documentation
File size: 5.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>buildreadcmd.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="buildcmd.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="changefield.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/AUTOUR_de_XXX/</font></h1>
58    <h2>buildreadcmd.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65   
66
67     
68      <a name="#_buildreadcmd"></a>
69
70      <h2>buildreadcmd  </h2>
71
72      <p><font face="Courier"><i>result = </i>buildreadcmd(<i><a href="#_buildreadcmd_keyword_base">base</a>, <a href="#_buildreadcmd_keyword_snameexp">snameexp</a>, <a href="#_buildreadcmd_keyword_procedure">procedure</a>, <a href="#_buildreadcmd_keyword_type">type</a></i>, <a href="#_buildreadcmd_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_buildreadcmd_keyword_COMPLETE">COMPLETE</a>=<i>COMPLETE</i>, <a href="#_buildreadcmd_keyword_NAMEFIELD">NAMEFIELD</a>=<i>NAMEFIELD</i>)</font></p>
73
74   
75
76
77   
78
79   
80    <h3>Parameters</h3>
81   
82
83    <a name="#_buildreadcmd_keyword_base"></a>
84    <h4>base&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
85      <font size="-1" color="#006633">in</font>
86     
87     
88      <font size="-1" color="#006633">required</font>
89     
90     
91     
92     
93    </h4>
94
95   
96 The id of the widget where apply the drawing.
97
98   
99
100    <a name="#_buildreadcmd_keyword_snameexp"></a>
101    <h4>snameexp&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
102      <font size="-1" color="#006633">in</font>
103     
104     
105      <font size="-1" color="#006633">required</font>
106     
107     
108     
109     
110    </h4>
111
112   
113
114   
115
116    <a name="#_buildreadcmd_keyword_procedure"></a>
117    <h4>procedure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
118      <font size="-1" color="#006633">in</font>
119     
120     
121      <font size="-1" color="#006633">required</font>
122     
123     
124     
125     
126    </h4>
127
128   
129
130   
131
132    <a name="#_buildreadcmd_keyword_type"></a>
133    <h4>type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134      <font size="-1" color="#006633">in</font>
135     
136     
137      <font size="-1" color="#006633">required</font>
138     
139     
140     
141     
142    </h4>
143
144   
145
146   
147   
148
149   
150    <h3>Keywords</h3>
151
152   
153    <a name="#_buildreadcmd_keyword_BOXZOOM"></a>
154    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155     
156     
157     
158     
159     
160     
161     
162     
163    </h4>
164
165   
166 Vector indicating the geographic zone on which we want to cut the map.
167 If BOXZOOM has :
168   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
169   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
170   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
171   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
172   6 elements: The extraction is made on Boxzoom
173 Where lon1, lon2,lat1,lat2 are global variables defined at the last
174 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
175
176   
177    <a name="#_buildreadcmd_keyword_COMPLETE"></a>
178    <h4>COMPLETE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179     
180     
181     
182     
183     
184     
185     
186     
187    </h4>
188
189   
190
191   
192    <a name="#_buildreadcmd_keyword_NAMEFIELD"></a>
193    <h4>NAMEFIELD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195     
196     
197     
198     
199     
200     
201     
202    </h4>
203
204   
205
206   
207   
208
209   
210    </pre><h3>Version history</h3>
211   
212    <h4>Version</h4>
213 $Id: buildreadcmd.pro 370 2008-08-07 07:59:15Z pinsard $
214
215    <h4>History</h4>
216 Sebastien Masson (smasson@lodyc.jussieu.fr)
217
218   
219
220    <h3>Known issues</h3>
221   
222   
223    <h4>Todo items</h4>
224 seb: documenter les param et les keyword qui ne le sont pas.
225
226   
227
228    <h3>Other attributes</h3>
229   
230   
231    <h4>Uses routines</h4>
232 <a href="../../..//Obsolete/common.html">common</a>
233
234   
235   
236   
237
238    <font size="-3"><p>&nbsp;</p></font>
239    <hr size="1" color="#CCCCCC"/>
240     
241
242   
243
244    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
245
246  </body>
247</html>
Note: See TracBrowser for help on using the repository browser.