source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_domain.html @ 338

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

update documentation
File size: 11.8 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>cw_domain.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="cw_domain.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/COMPOUND_WIDGET//cw_domain.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="cw_combobox_pm.html">&lt;&lt;prev file</a> | <a href="cw_droplist_pm.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_domain.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">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
82      <h2 class="pro_file">cw_domain.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</div>
97
98     
99
100     
101
102     
103
104     
105      <div id="routine_summary">               
106        <h2>Routine summary</h2>
107       
108        <dl>
109         
110          <dt><p><a href="#_cw_domain_set_value">cw_domain_set_value<span class="result">, id, value</span></a></p><dt>
111          <dd> </dd>   
112         
113          <dt><p><a href="#_cw_domain_get_value"><span class="result">result = </span>cw_domain_get_value(<span class="result">id</span>)</a></p><dt>
114          <dd> </dd>   
115         
116          <dt><p><a href="#_cw_domain_event"><span class="result">result = </span>cw_domain_event(<span class="result">event</span>)</a></p><dt>
117          <dd> </dd>   
118         
119          <dt><p><a href="#_cw_domain"><span class="result">result = </span>cw_domain(<span class="result">parent</span>, BOXZOOM=<span class="result">BOXZOOM</span>, STRICT=<span class="result">STRICT</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, UNZOOM=<span class="result">UNZOOM</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
120          <dd> </dd>   
121               
122        </dl>
123      </div>
124     
125
126      <div id="routine_details">
127       
128
129        <div class="routine_details" id="_cw_domain_set_value">
130
131          <h2><a class="top" href="#container">top</a>cw_domain_set_value <span class="categories">
132 Compound widget
133</span></h2>
134       
135          <p class="header">
136            cw_domain_set_value<span class="result">, <a href="#_cw_domain_set_value_param_id">id</a>, <a href="#_cw_domain_set_value_param_value">value</a></span></p>
137       
138          <div class="comments">
139</div>
140
141          <h3>Return value</h3><div class="preformat">
142</div>
143
144         
145            <h3>Parameters</h3>
146       
147           
148            <h4 id="_cw_domain_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
159          <div class="comments">
160
161</div>
162           
163            <h4 id="_cw_domain_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174          <div class="comments">
175 It is the default tick mark value (a floating-point number).
176</div>
177           
178
179         
180
181         
182
183          <h3>Examples</h3><div class="preformat">
184</div>
185          <h3>Version history</h3>
186         
187          <h4>Version</h4><div class="preformat">
188 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
189</div>
190          <h4>History</h4><div class="preformat">
191</div>
192         
193         
194          <h3>Known issues</h3>
195         
196         
197         
198          <h4>Restrictions</h4><div class="preformat">
199</div>
200       
201          <h3>Other attributes</h3>
202         
203         
204          <h4>Uses routines</h4><div class="preformat">
205</div>
206         
207         
208         
209       
210          <h3>Statistics</h3>
211          <table class="statistics">
212            <tr><td>McCabe cyclic</td><td>          26</td></tr>
213            <tr><td>McCabe essential</td><td>           1</td></tr>
214            <tr><td>McCabe modular design</td><td>           1</td></tr>
215          </table>
216         
217       
218        </div>
219       
220
221        <div class="routine_details" id="_cw_domain_get_value">
222
223          <h2><a class="top" href="#container">top</a>cw_domain_get_value <span class="categories">
224 Compound widget
225</span></h2>
226       
227          <p class="header">
228            <span class="result">result = </span>cw_domain_get_value(<span class="result"><a href="#_cw_domain_get_value_param_id">id</a></span>)</p>
229       
230          <div class="comments">
231</div>
232
233          <h3>Return value</h3><div class="preformat">
234</div>
235
236         
237            <h3>Parameters</h3>
238       
239           
240            <h4 id="_cw_domain_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246             
247             
248             
249            </h4>
250       
251          <div class="comments">
252</div>
253           
254
255         
256
257         
258
259          <h3>Examples</h3><div class="preformat">
260</div>
261          <h3>Version history</h3>
262         
263          <h4>Version</h4><div class="preformat">
264 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
265</div>
266          <h4>History</h4><div class="preformat">
267</div>
268         
269         
270          <h3>Known issues</h3>
271         
272         
273         
274          <h4>Restrictions</h4><div class="preformat">
275</div>
276       
277          <h3>Other attributes</h3>
278         
279         
280          <h4>Uses routines</h4><div class="preformat">
281</div>
282         
283         
284         
285       
286          <h3>Statistics</h3>
287          <table class="statistics">
288            <tr><td>McCabe cyclic</td><td>           2</td></tr>
289            <tr><td>McCabe essential</td><td>           1</td></tr>
290            <tr><td>McCabe modular design</td><td>           1</td></tr>
291          </table>
292         
293       
294        </div>
295       
296
297        <div class="routine_details" id="_cw_domain_event">
298
299          <h2><a class="top" href="#container">top</a>cw_domain_event <span class="categories">
300 Compound widget
301</span></h2>
302       
303          <p class="header">
304            <span class="result">result = </span>cw_domain_event(<span class="result"><a href="#_cw_domain_event_param_event">event</a></span>)</p>
305       
306          <div class="comments">
307</div>
308
309          <h3>Return value</h3><div class="preformat">
310</div>
311
312         
313            <h3>Parameters</h3>
314       
315           
316            <h4 id="_cw_domain_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
317             
318             
319             
320             
321             
322             
323             
324             
325            </h4>
326       
327          <div class="comments">
328</div>
329           
330
331         
332
333         
334
335          <h3>Examples</h3><div class="preformat">
336</div>
337          <h3>Version history</h3>
338         
339          <h4>Version</h4><div class="preformat">
340 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
341</div>
342          <h4>History</h4><div class="preformat">
343</div>
344         
345         
346          <h3>Known issues</h3>
347         
348         
349         
350          <h4>Restrictions</h4><div class="preformat">
351</div>
352       
353          <h3>Other attributes</h3>
354         
355         
356          <h4>Uses routines</h4><div class="preformat">
357</div>
358         
359         
360         
361       
362          <h3>Statistics</h3>
363          <table class="statistics">
364            <tr><td>McCabe cyclic</td><td>          23</td></tr>
365            <tr><td>McCabe essential</td><td>           1</td></tr>
366            <tr><td>McCabe modular design</td><td>           1</td></tr>
367          </table>
368         
369       
370        </div>
371       
372
373        <div class="routine_details" id="_cw_domain">
374
375          <h2><a class="top" href="#container">top</a>cw_domain <span class="categories">
376 Compound widget
377</span></h2>
378       
379          <p class="header">
380            <span class="result">result = </span>cw_domain(<span class="result"><a href="#_cw_domain_param_parent">parent</a></span>, <a href="#_cw_domain_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_cw_domain_keyword_STRICT">STRICT</a>=<span class="result">STRICT</span>, <a href="#_cw_domain_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_domain_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_domain_keyword_UNZOOM">UNZOOM</a>=<span class="result">UNZOOM</span>, <a href="#_cw_domain_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
381       
382          <div class="comments">
383</div>
384
385          <h3>Return value</h3><div class="preformat">
386</div>
387
388         
389            <h3>Parameters</h3>
390       
391           
392            <h4 id="_cw_domain_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
393              <span class="attr">in</span>
394             
395             
396              <span class="attr">required</span>
397             
398             
399             
400             
401            </h4>
402       
403          <div class="comments">
404 The widget ID of the parent widget.
405</div>
406           
407
408         
409
410         
411
412            <h3>Keywords</h3>
413           
414            <h4 id="_cw_domain_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
415             
416             
417             
418             
419             
420             
421             
422             
423            </h4>
424       
425            <div class="comments">
426 Vector indicating the geographic zone on which we want to cut the map.
427 If BOXZOOM has :
428   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
429   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
430   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
431   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
432   6 elements: The extraction is made on Boxzoom
433 Where lon1, lon2,lat1,lat2 are global variables defined at the last
434 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>!
435</div>
436           
437            <h4 id="_cw_domain_keyword_STRICT">STRICT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
438             
439             
440             
441             
442             
443             
444             
445             
446            </h4>
447       
448            <div class="comments">
449</div>
450           
451            <h4 id="_cw_domain_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
452             
453             
454             
455             
456             
457             
458             
459             
460            </h4>
461       
462            <div class="comments">
463 The user value to be associated with the widget.
464</div>
465           
466            <h4 id="_cw_domain_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
467             
468             
469             
470             
471             
472             
473             
474             
475            </h4>
476       
477            <div class="comments">
478 The user name to be associated with the widget.
479</div>
480           
481            <h4 id="_cw_domain_keyword_UNZOOM">UNZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
482             
483             
484             
485             
486             
487             
488             
489             
490            </h4>
491       
492            <div class="comments">
493</div>
494           
495            <h4 id="_cw_domain_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
496             
497             
498             
499             
500             
501             
502             
503             
504            </h4>
505       
506            <div class="comments">
507 Used to pass keywords
508</div>
509           
510         
511
512          <h3>Examples</h3><div class="preformat">
513</div>
514          <h3>Version history</h3>
515         
516          <h4>Version</h4><div class="preformat">
517 $Id: cw_domain.pro 327 2007-12-13 16:22:35Z pinsard $
518</div>
519          <h4>History</h4><div class="preformat">
520</div>
521         
522         
523          <h3>Known issues</h3>
524         
525         
526          <h4>Todo items</h4><div class="preformat">
527 seb: Documenter
528</div>
529          <h4>Restrictions</h4><div class="preformat">
530</div>
531       
532          <h3>Other attributes</h3>
533         
534         
535          <h4>Uses routines</h4><div class="preformat">
536</div>
537         
538         
539         
540       
541          <h3>Statistics</h3>
542          <table class="statistics">
543            <tr><td>McCabe cyclic</td><td>          17</td></tr>
544            <tr><td>McCabe essential</td><td>           1</td></tr>
545            <tr><td>McCabe modular design</td><td>           1</td></tr>
546          </table>
547         
548       
549        </div>
550       
551      </div>
552
553     
554
555      <div id="tagline">Produced by IDLdoc 2.0.</div>
556
557    </div>
558
559  </body>
560</html>
Note: See TracBrowser for help on using the repository browser.