source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildcmd.html @ 338

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

update documentation

File size: 3.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>buildcmd.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=""><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="buildreadcmd.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>buildcmd.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 This function send back a string which contain the reading command
65 and drawing's parameters.
66
67
68   
69
70     
71      <a name="#_buildcmd"></a>
72
73      <h2>buildcmd  </h2>
74
75      <p><font face="Courier"><i>result = </i>buildcmd(<i><a href="#_buildcmd_keyword_base">base</a></i>, <a href="#_buildcmd_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_buildcmd_keyword_FORCETYPE">FORCETYPE</a>=<i>FORCETYPE</i>)</font></p>
76
77   
78
79
80   
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_buildcmd_keyword_base"></a>
87    <h4>base&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88      <font size="-1" color="#006633">in</font>
89     
90     
91      <font size="-1" color="#006633">required</font>
92     
93     
94     
95     
96    </h4>
97
98   
99
100   
101   
102
103   
104    <h3>Keywords</h3>
105
106   
107    <a name="#_buildcmd_keyword_BOXZOOM"></a>
108    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109     
110     
111     
112     
113     
114     
115     
116     
117    </h4>
118
119   
120 Vector indicating the geographic zone on which we want to cut the map.
121 If BOXZOOM has :
122   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
123   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
124   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
125   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
126   6 elements: The extraction is made on Boxzoom
127 Where lon1, lon2,lat1,lat2 are global variables defined at the last
128 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
129
130   
131    <a name="#_buildcmd_keyword_FORCETYPE"></a>
132    <h4>FORCETYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
133     
134     
135     
136     
137     
138     
139     
140     
141    </h4>
142
143   
144
145   
146   
147
148   
149    </pre><h3>Version history</h3>
150   
151    <h4>Version</h4>
152 $Id: buildcmd.pro 327 2007-12-13 16:22:35Z pinsard $
153
154    <h4>History</h4>
155 Sebastien Masson (smasson@lodyc.jussieu.fr)
156
157   
158
159    <h3>Known issues</h3>
160   
161   
162    <h4>Todo items</h4>
163 seb: documenter le param BASE et le keyword FORCETYPE
164
165   
166
167   
168   
169   
170   
171   
172   
173   
174
175    <font size="-3"><p>&nbsp;</p></font>
176    <hr size="1" color="#CCCCCC"/>
177     
178
179   
180
181    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
182
183  </body>
184</html>
Note: See TracBrowser for help on using the repository browser.