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

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

update documentation
File size: 6.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>changefile.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="changefile.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//changefile.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="changefield.html">&lt;&lt;prev file</a> | <a href="createhistory.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="changefile.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">changefile.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="_changefile">
104
105          <h2><a class="top" href="#container">top</a>changefile <span class="categories">
106</span></h2>
107       
108          <p class="header">
109            changefile<span class="result">, <a href="#_changefile_param_base">base</a>, <a href="#_changefile_param_newfilename">newfilename</a></span>, <a href="#_changefile_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_changefile_keyword_DATE1">DATE1</a>=<span class="result">DATE1</span>, <a href="#_changefile_keyword_DATE2">DATE2</a>=<span class="result">DATE2</span>, <a href="#_changefile_keyword_FIELDNAME">FIELDNAME</a>=<span class="result">FIELDNAME</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="_changefile_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 The id of the widget where apply the drawing.
134</div>
135           
136            <h4 id="_changefile_param_newfilename">newfilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137             
138             
139             
140             
141             
142             
143             
144             
145            </h4>
146       
147          <div class="comments">
148</div>
149           
150
151         
152
153         
154
155            <h3>Keywords</h3>
156           
157            <h4 id="_changefile_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164             
165             
166            </h4>
167       
168            <div class="comments">
169 Vector indicating the geographic zone on which we want to cut the map.
170 If BOXZOOM has :
171   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
172   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
173   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
174   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
175   6 elements: The extraction is made on Boxzoom
176 Where lon1, lon2,lat1,lat2 are global variables defined at the last
177 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
178</div>
179           
180            <h4 id="_changefile_keyword_DATE1">DATE1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186             
187             
188             
189            </h4>
190       
191            <div class="comments">
192</div>
193           
194            <h4 id="_changefile_keyword_DATE2">DATE2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205            <div class="comments">
206</div>
207           
208            <h4 id="_changefile_keyword_FIELDNAME">FIELDNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
209             
210             
211             
212             
213             
214             
215             
216             
217            </h4>
218       
219            <div class="comments">
220</div>
221           
222         
223
224          <h3>Examples</h3><div class="preformat">
225</div>
226          <h3>Version history</h3>
227         
228          <h4>Version</h4><div class="preformat">
229 $Id: changefile.pro 327 2007-12-13 16:22:35Z pinsard $
230</div>
231          <h4>History</h4><div class="preformat">
232</div>
233         
234         
235          <h3>Known issues</h3>
236         
237         
238          <h4>Todo items</h4><div class="preformat">
239 seb
240</div>
241          <h4>Restrictions</h4><div class="preformat">
242</div>
243       
244          <h3>Other attributes</h3>
245         
246         
247          <h4>Uses routines</h4><div class="preformat">
248</div>
249         
250         
251         
252       
253          <h3>Statistics</h3>
254          <table class="statistics">
255            <tr><td>McCabe cyclic</td><td>          18</td></tr>
256            <tr><td>McCabe essential</td><td>           1</td></tr>
257            <tr><td>McCabe modular design</td><td>           1</td></tr>
258          </table>
259         
260       
261        </div>
262       
263      </div>
264
265     
266
267      <div id="tagline">Produced by IDLdoc 2.0.</div>
268
269    </div>
270
271  </body>
272</html>
Note: See TracBrowser for help on using the repository browser.