source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper2.html @ 338

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

update documentation
File size: 8.2 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>ncdf_quickwrite_helper2.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="ncdf_quickwrite_helper2.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="../../../../../ReadWrite/idl-NetCDF/ncdf_quickwrite//ncdf_quickwrite_helper2.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="ncdf_quickwrite_helper1.html">&lt;&lt;prev file</a> | <a href="ncdf_quickwrite_helper3.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_quickwrite_helper2.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&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">ReadWrite/idl-NetCDF/ncdf_quickwrite/</a></h1>
82      <h2 class="pro_file">ncdf_quickwrite_helper2.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92
93
94
95
96
97</div>
98
99     
100
101     
102
103     
104
105     
106      <div id="routine_summary">               
107        <h2>Routine summary</h2>
108       
109        <dl>
110         
111          <dt><p><a href="#__str"><span class="result">result = </span>_str(<span class="result">string</span>)</a></p><dt>
112          <dd></dd>     
113         
114          <dt><p><a href="#_ncdf_quickwrite_typename"><span class="result">result = </span>ncdf_quickwrite_typename(<span class="result">num, name</span>)</a></p><dt>
115          <dd></dd>     
116         
117          <dt><p><a href="#_ncdf_quickwrite_helper2">ncdf_quickwrite_helper2<span class="result">, ncfilename, s, sname</span></a></p><dt>
118          <dd></dd>     
119               
120        </dl>
121      </div>
122     
123
124      <div id="routine_details">
125       
126
127        <div class="routine_details" id="__str">
128
129          <h2><a class="top" href="#container">top</a>_str <span class="categories">
130
131</span></h2>
132       
133          <p class="header">
134            <span class="result">result = </span>_str(<span class="result"><a href="#__str_param_string">string</a></span>)</p>
135       
136          <div class="comments"></div>
137
138          <h3>Return value</h3><div class="preformat">
139
140</div>
141
142         
143            <h3>Parameters</h3>
144       
145           
146            <h4 id="__str_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
157          <div class="comments">
158 String to be split. Contains text after in, out token on output.
159 
160</div>
161           
162
163         
164
165         
166
167          <h3>Examples</h3><div class="preformat">
168 
169 </div>
170          <h3>Version history</h3>
171         
172          <h4>Version</h4><div class="preformat">
173 $Id: ncdf_quickwrite_helper2.pro 325 2007-12-06 10:04:53Z pinsard $
174</div>
175          <h4>History</h4><div class="preformat">
176
177</div>
178         
179         
180          <h3>Known issues</h3>
181         
182         
183         
184          <h4>Restrictions</h4><div class="preformat">
185
186</div>
187       
188         
189         
190         
191         
192         
193         
194         
195       
196          <h3>Statistics</h3>
197          <table class="statistics">
198            <tr><td>McCabe cyclic</td><td>           1</td></tr>
199            <tr><td>McCabe essential</td><td>           1</td></tr>
200            <tr><td>McCabe modular design</td><td>           1</td></tr>
201          </table>
202         
203       
204        </div>
205       
206
207        <div class="routine_details" id="_ncdf_quickwrite_typename">
208
209          <h2><a class="top" href="#container">top</a>ncdf_quickwrite_typename <span class="categories">
210
211</span></h2>
212       
213          <p class="header">
214            <span class="result">result = </span>ncdf_quickwrite_typename(<span class="result"><a href="#_ncdf_quickwrite_typename_param_num">num</a>, <a href="#_ncdf_quickwrite_typename_param_name">name</a></span>)</p>
215       
216          <div class="comments"></div>
217
218          <h3>Return value</h3><div class="preformat">
219
220</div>
221
222         
223            <h3>Parameters</h3>
224       
225           
226            <h4 id="_ncdf_quickwrite_typename_param_num">num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
227             
228             
229             
230             
231             
232             
233             
234             
235            </h4>
236       
237          <div class="comments">
238
239</div>
240           
241            <h4 id="_ncdf_quickwrite_typename_param_name">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242             
243             
244             
245             
246             
247              <span class="attr">type:</span> <span class="value">string</span>
248             
249             
250            </h4>
251       
252          <div class="comments">
253 It is a string giving the name of the file to be opened. If NAME does not contain
254 the separating character of directories ('/' under unix for example), the file
255 will be looked for in the current directory.
256 
257</div>
258           
259
260         
261
262         
263
264          <h3>Examples</h3><div class="preformat">
265 
266 </div>
267          <h3>Version history</h3>
268         
269          <h4>Version</h4><div class="preformat">
270 $Id: ncdf_quickwrite_helper2.pro 325 2007-12-06 10:04:53Z pinsard $
271</div>
272          <h4>History</h4><div class="preformat">
273
274</div>
275         
276         
277          <h3>Known issues</h3>
278         
279         
280         
281          <h4>Restrictions</h4><div class="preformat">
282
283</div>
284       
285         
286         
287         
288         
289         
290         
291         
292       
293          <h3>Statistics</h3>
294          <table class="statistics">
295            <tr><td>McCabe cyclic</td><td>          14</td></tr>
296            <tr><td>McCabe essential</td><td>           1</td></tr>
297            <tr><td>McCabe modular design</td><td>           1</td></tr>
298          </table>
299         
300       
301        </div>
302       
303
304        <div class="routine_details" id="_ncdf_quickwrite_helper2">
305
306          <h2><a class="top" href="#container">top</a>ncdf_quickwrite_helper2 <span class="categories">
307
308</span></h2>
309       
310          <p class="header">
311            ncdf_quickwrite_helper2<span class="result">, <a href="#_ncdf_quickwrite_helper2_param_ncfilename">ncfilename</a>, <a href="#_ncdf_quickwrite_helper2_param_s">s</a>, <a href="#_ncdf_quickwrite_helper2_param_sname">sname</a></span></p>
312       
313          <div class="comments"></div>
314
315          <h3>Return value</h3><div class="preformat">
316
317</div>
318
319         
320            <h3>Parameters</h3>
321       
322           
323            <h4 id="_ncdf_quickwrite_helper2_param_ncfilename">ncfilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
324             
325             
326             
327             
328             
329             
330             
331             
332            </h4>
333       
334          <div class="comments">
335
336</div>
337           
338            <h4 id="_ncdf_quickwrite_helper2_param_s">s&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
339             
340             
341             
342             
343             
344             
345             
346             
347            </h4>
348       
349          <div class="comments">
350 The string to be searched
351</div>
352           
353            <h4 id="_ncdf_quickwrite_helper2_param_sname">sname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
354             
355             
356             
357             
358             
359             
360             
361             
362            </h4>
363       
364          <div class="comments">
365 
366</div>
367           
368
369         
370
371         
372
373          <h3>Examples</h3><div class="preformat">
374 
375 </div>
376          <h3>Version history</h3>
377         
378          <h4>Version</h4><div class="preformat">
379 $Id: ncdf_quickwrite_helper2.pro 325 2007-12-06 10:04:53Z pinsard $
380</div>
381          <h4>History</h4><div class="preformat">
382
383</div>
384         
385         
386          <h3>Known issues</h3>
387         
388         
389         
390          <h4>Restrictions</h4><div class="preformat">
391
392</div>
393       
394         
395         
396         
397         
398         
399         
400         
401       
402          <h3>Statistics</h3>
403          <table class="statistics">
404            <tr><td>McCabe cyclic</td><td>          18</td></tr>
405            <tr><td>McCabe essential</td><td>           1</td></tr>
406            <tr><td>McCabe modular design</td><td>           1</td></tr>
407          </table>
408         
409       
410        </div>
411       
412      </div>
413
414     
415
416      <div id="tagline">Produced by IDLdoc 2.0.</div>
417
418    </div>
419
420  </body>
421</html>
Note: See TracBrowser for help on using the repository browser.