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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 11.8 KB
RevLine 
[89]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>
[104]9    <title>cw_domain.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="cw_domain.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../../ToBeReviewed/WIDGET/COMPOUND_WIDGET//cw_domain.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</a></h1>
[89]82      <h2 class="pro_file">cw_domain.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[151]89      <div id="file_comments">
[89]90
[157]91
92
93
94
95
[151]96</div>
97
[89]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>
[234]111          <dd> </dd>   
[89]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>
[234]114          <dd> </dd>   
[89]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>
[234]117          <dd> </dd>   
[89]118         
[234]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>   
[89]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
[157]131          <h2><a class="top" href="#container">top</a>cw_domain_set_value <span class="categories">
132 Compound widget
[234]133</span></h2>
[89]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       
[234]138          <div class="comments">
139</div>
[89]140
[157]141          <h3>Return value</h3><div class="preformat">
[234]142</div>
[89]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       
[157]159          <div class="comments">
160
161</div>
[89]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       
[157]174          <div class="comments">
175 It is the default tick mark value (a floating-point number).
176</div>
[89]177           
178
179         
180
181         
182
[157]183          <h3>Examples</h3><div class="preformat">
[234]184</div>
[157]185          <h3>Version history</h3>
[89]186         
[234]187          <h4>Version</h4><div class="preformat">
[402]188 $Id: cw_domain.pro 371 2008-08-07 09:32:02Z pinsard $
[338]189</div>
[157]190          <h4>History</h4><div class="preformat">
[234]191</div>
[89]192         
193         
[157]194          <h3>Known issues</h3>
[89]195         
196         
197         
[157]198          <h4>Restrictions</h4><div class="preformat">
[234]199</div>
[89]200       
[157]201          <h3>Other attributes</h3>
[89]202         
203         
[157]204          <h4>Uses routines</h4><div class="preformat">
[234]205</div>
[89]206         
207         
208         
209       
[163]210          <h3>Statistics</h3>
211          <table class="statistics">
[177]212            <tr><td>McCabe cyclic</td><td>          26</td></tr>
[163]213            <tr><td>McCabe essential</td><td>           1</td></tr>
214            <tr><td>McCabe modular design</td><td>           1</td></tr>
215          </table>
[89]216         
217       
218        </div>
219       
220
221        <div class="routine_details" id="_cw_domain_get_value">
222
[157]223          <h2><a class="top" href="#container">top</a>cw_domain_get_value <span class="categories">
224 Compound widget
[234]225</span></h2>
[89]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       
[234]230          <div class="comments">
231</div>
[89]232
[157]233          <h3>Return value</h3><div class="preformat">
[234]234</div>
[89]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       
[157]251          <div class="comments">
252</div>
[89]253           
254
255         
256
257         
258
[157]259          <h3>Examples</h3><div class="preformat">
[234]260</div>
[157]261          <h3>Version history</h3>
[89]262         
[234]263          <h4>Version</h4><div class="preformat">
[402]264 $Id: cw_domain.pro 371 2008-08-07 09:32:02Z pinsard $
[338]265</div>
[157]266          <h4>History</h4><div class="preformat">
[234]267</div>
[89]268         
269         
[157]270          <h3>Known issues</h3>
[89]271         
272         
273         
[157]274          <h4>Restrictions</h4><div class="preformat">
[234]275</div>
[89]276       
[157]277          <h3>Other attributes</h3>
[89]278         
279         
[157]280          <h4>Uses routines</h4><div class="preformat">
[234]281</div>
[89]282         
283         
284         
285       
[163]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>
[89]292         
293       
294        </div>
295       
296
297        <div class="routine_details" id="_cw_domain_event">
298
[157]299          <h2><a class="top" href="#container">top</a>cw_domain_event <span class="categories">
300 Compound widget
[234]301</span></h2>
[89]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       
[234]306          <div class="comments">
307</div>
[89]308
[157]309          <h3>Return value</h3><div class="preformat">
[234]310</div>
[89]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       
[157]327          <div class="comments">
328</div>
[89]329           
330
331         
332
333         
334
[157]335          <h3>Examples</h3><div class="preformat">
[234]336</div>
[157]337          <h3>Version history</h3>
[89]338         
[234]339          <h4>Version</h4><div class="preformat">
[402]340 $Id: cw_domain.pro 371 2008-08-07 09:32:02Z pinsard $
[338]341</div>
[157]342          <h4>History</h4><div class="preformat">
[234]343</div>
[89]344         
345         
[157]346          <h3>Known issues</h3>
[89]347         
348         
349         
[157]350          <h4>Restrictions</h4><div class="preformat">
[234]351</div>
[89]352       
[157]353          <h3>Other attributes</h3>
[89]354         
355         
[157]356          <h4>Uses routines</h4><div class="preformat">
[234]357</div>
[89]358         
359         
360         
361       
[163]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>
[89]368         
369       
370        </div>
371       
372
373        <div class="routine_details" id="_cw_domain">
374
[151]375          <h2><a class="top" href="#container">top</a>cw_domain <span class="categories">
[157]376 Compound widget
[234]377</span></h2>
[89]378       
379          <p class="header">
[234]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>
[89]381       
[234]382          <div class="comments">
383</div>
[89]384
[151]385          <h3>Return value</h3><div class="preformat">
[234]386</div>
[89]387
388         
389            <h3>Parameters</h3>
390       
391           
392            <h4 id="_cw_domain_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[151]393              <span class="attr">in</span>
[89]394             
395             
[151]396              <span class="attr">required</span>
[89]397             
398             
399             
400             
401            </h4>
402       
[151]403          <div class="comments">
404 The widget ID of the parent widget.
[234]405</div>
[89]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       
[151]425            <div class="comments">
[234]426 Vector indicating the geographic zone on which we want to cut the map.
427 If BOXZOOM has :
[151]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]]
[234]432   6 elements: The extraction is made on Boxzoom
[290]433 Where lon1, lon2,lat1,lat2 are global variables defined at the last
434 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a>!
[151]435</div>
[89]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       
[151]448            <div class="comments">
449</div>
[89]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       
[151]462            <div class="comments">
463 The user value to be associated with the widget.
[234]464</div>
[89]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       
[151]477            <div class="comments">
478 The user name to be associated with the widget.
[234]479</div>
[89]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       
[151]492            <div class="comments">
493</div>
[89]494           
[234]495            <h4 id="_cw_domain_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]496             
497             
498             
499             
500             
501             
502             
503             
504            </h4>
505       
[151]506            <div class="comments">
[234]507 Used to pass keywords
508</div>
[89]509           
510         
511
[151]512          <h3>Examples</h3><div class="preformat">
[234]513</div>
[151]514          <h3>Version history</h3>
[89]515         
[234]516          <h4>Version</h4><div class="preformat">
[402]517 $Id: cw_domain.pro 371 2008-08-07 09:32:02Z pinsard $
[151]518</div>
519          <h4>History</h4><div class="preformat">
[234]520</div>
[89]521         
522         
[151]523          <h3>Known issues</h3>
[89]524         
525         
[151]526          <h4>Todo items</h4><div class="preformat">
527 seb: Documenter
[234]528</div>
[151]529          <h4>Restrictions</h4><div class="preformat">
[234]530</div>
[89]531       
[151]532          <h3>Other attributes</h3>
[89]533         
534         
[151]535          <h4>Uses routines</h4><div class="preformat">
[234]536</div>
[89]537         
538         
539         
540       
[163]541          <h3>Statistics</h3>
542          <table class="statistics">
[177]543            <tr><td>McCabe cyclic</td><td>          17</td></tr>
[163]544            <tr><td>McCabe essential</td><td>           1</td></tr>
545            <tr><td>McCabe modular design</td><td>           1</td></tr>
546          </table>
[89]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>
[249]560</html>
Note: See TracBrowser for help on using the repository browser.