source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildcmd.html

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

update documentation
File size: 5.0 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>buildcmd.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="buildcmd.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//buildcmd.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&lt;&lt; prev file | <a href="buildreadcmd.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="buildcmd.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">buildcmd.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 This function send back a string which contain the reading command
91 and drawing's parameters.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_buildcmd">
106
107          <h2><a class="top" href="#container">top</a>buildcmd </h2>
108       
109          <p class="header">
110            <span class="result">result = </span>buildcmd(<span class="result"><a href="#_buildcmd_param_base">base</a></span>, <a href="#_buildcmd_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_buildcmd_keyword_FORCETYPE">FORCETYPE</a>=<span class="result">FORCETYPE</span>)</p>
111       
112          <div class="comments">
113</div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_buildcmd_param_base">base&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments">
133</div>
134           
135
136         
137
138         
139
140            <h3>Keywords</h3>
141           
142            <h4 id="_buildcmd_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148             
149             
150             
151            </h4>
152       
153            <div class="comments">
154 Vector indicating the geographic zone on which we want to cut the map.
155 If BOXZOOM has :
156   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
157   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
158   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
159   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
160   6 elements: The extraction is made on Boxzoom
161 Where lon1, lon2,lat1,lat2 are global variables defined at the last
162 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
163</div>
164           
165            <h4 id="_buildcmd_keyword_FORCETYPE">FORCETYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177</div>
178           
179         
180
181         
182          <h3>Version history</h3>
183         
184          <h4>Version</h4><div class="preformat">
185 $Id: buildcmd.pro 327 2007-12-13 16:22:35Z pinsard $
186</div>
187          <h4>History</h4><div class="preformat">
188 Sebastien Masson (smasson@lodyc.jussieu.fr)
189</div>
190         
191         
192          <h3>Known issues</h3>
193         
194         
195          <h4>Todo items</h4><div class="preformat">
196 seb: documenter le param BASE et le keyword FORCETYPE
197</div>
198         
199       
200         
201         
202         
203         
204         
205         
206         
207       
208          <h3>Statistics</h3>
209          <table class="statistics">
210            <tr><td>McCabe cyclic</td><td>          68</td></tr>
211            <tr><td>McCabe essential</td><td>           1</td></tr>
212            <tr><td>McCabe modular design</td><td>           1</td></tr>
213          </table>
214         
215       
216        </div>
217       
218      </div>
219
220     
221
222      <div id="tagline">Produced by IDLdoc 2.0.</div>
223
224    </div>
225
226  </body>
227</html>
Note: See TracBrowser for help on using the repository browser.