Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: