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>checkfield.pro (SAXO Documentation)</title> |
---|
10 | |
---|
11 | |
---|
12 | <style type="text/css" media="all"> |
---|
13 | |
---|
14 | /* CSS for all files which appear in the "main" viewing area: overview, |
---|
15 | directory overviews, warnings, index, search, pro files, source |
---|
16 | code, help, and etc files. */ |
---|
17 | |
---|
18 | /* Link styles --------------------------------------------------------------- */ |
---|
19 | |
---|
20 | a { text-decoration: none; } |
---|
21 | |
---|
22 | a:link, a:visited { |
---|
23 | color: #660000; |
---|
24 | border-bottom: 1px dotted #C0C0F0; |
---|
25 | } |
---|
26 | |
---|
27 | a:hover, a:focus { |
---|
28 | color: #993333; |
---|
29 | background: #FFFFCC; |
---|
30 | border-bottom: 1px dotted #303099; |
---|
31 | } |
---|
32 | |
---|
33 | |
---|
34 | /* Main styles --------------------------------------------------------------- */ |
---|
35 | |
---|
36 | body { |
---|
37 | margin: 0; |
---|
38 | padding: 0; |
---|
39 | font-size: 10pt; |
---|
40 | font-family: Verdana, Helvetica, Arial, sans-serif; |
---|
41 | background-color: #FFFFFF; |
---|
42 | } |
---|
43 | |
---|
44 | p { |
---|
45 | margin-top: 0.5em; |
---|
46 | margin-bottom: 0; |
---|
47 | } |
---|
48 | |
---|
49 | #container { margin: 1em; } |
---|
50 | |
---|
51 | code.section { white-space: pre; } |
---|
52 | |
---|
53 | pre.snippet { |
---|
54 | margin-left: 5%; |
---|
55 | background: #F0F0F0; |
---|
56 | border: 1px dashed #999999; |
---|
57 | width: 43em; |
---|
58 | padding: 0.5em 0.5em 0.5em 0.5em; |
---|
59 | white-space: pre; |
---|
60 | } |
---|
61 | |
---|
62 | /* Navbar styles ------------------------------------------------------------- */ |
---|
63 | |
---|
64 | #navbar_title { |
---|
65 | color: #000033; |
---|
66 | background-color: #F0F0FF; |
---|
67 | font-family: Arial, Helvetica, sans-serif; |
---|
68 | padding: 20px 30px; |
---|
69 | border-bottom: 1px solid #000033; |
---|
70 | } |
---|
71 | |
---|
72 | #navbar_title * { |
---|
73 | margin: 0; |
---|
74 | padding: 0; |
---|
75 | } |
---|
76 | |
---|
77 | #navbar_title h1 { |
---|
78 | letter-spacing: 0.1em; |
---|
79 | font-variant: small-caps; |
---|
80 | font-size: 250%; |
---|
81 | text-indent: -1em; |
---|
82 | padding-left: 1em; |
---|
83 | } |
---|
84 | |
---|
85 | #navbar_title h2 { |
---|
86 | font-size: 110%; |
---|
87 | font-weight: normal; |
---|
88 | color: #333399; |
---|
89 | } |
---|
90 | |
---|
91 | #main_navbar table { |
---|
92 | width: 100%; |
---|
93 | border-bottom: 1px solid #666699; |
---|
94 | } |
---|
95 | |
---|
96 | #main_navbar td { |
---|
97 | background: #CCCCFF; |
---|
98 | font-size: 80%; |
---|
99 | font-weight: bold; |
---|
100 | font-family: Arial, Helvetica, sans-serif; |
---|
101 | border-top: 3px solid #CCCCFF; |
---|
102 | border-bottom: 3px solid #CCCCFF; |
---|
103 | padding-left: 6px; |
---|
104 | padding-right: 6px; |
---|
105 | margin: 0; |
---|
106 | } |
---|
107 | |
---|
108 | #main_navbar td#selected { |
---|
109 | background: #CCCCFF; |
---|
110 | font-size: 80%; |
---|
111 | font-weight: bold; |
---|
112 | font-family: Arial, Helvetica, sans-serif; |
---|
113 | border-top: 3px solid #333399; |
---|
114 | border-bottom: 3px solid #CCCCFF; |
---|
115 | padding-left: 6px; |
---|
116 | padding-right: 6px; |
---|
117 | margin: 0; |
---|
118 | } |
---|
119 | |
---|
120 | #main_navbar td#flexible { |
---|
121 | width: 100%; |
---|
122 | text-align: right; |
---|
123 | padding-right: 1em; |
---|
124 | background: #CCCCFF; |
---|
125 | font-size: 70%; |
---|
126 | font-weight: normal; |
---|
127 | font-family: Arial, Helvetica, sans-serif; |
---|
128 | text-transform: uppercase; |
---|
129 | border-top: 3px solid #CCCCFF; |
---|
130 | border-bottom: 3px solid #CCCCFF; |
---|
131 | } |
---|
132 | |
---|
133 | #main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; } |
---|
134 | |
---|
135 | #main_navbar a:hover, #main_navbar a:focus { |
---|
136 | color: #FFFF66; |
---|
137 | background: #CCCCFF; |
---|
138 | border-bottom: 1px none #606099; |
---|
139 | border: 0; |
---|
140 | } |
---|
141 | |
---|
142 | #secondary_navbar { |
---|
143 | font-size: 80%; |
---|
144 | font-weight: normal; |
---|
145 | font-family: Arial, Helvetica, sans-serif; |
---|
146 | margin-top: 4px; |
---|
147 | margin-left: 20px; |
---|
148 | white-space: nowrap; |
---|
149 | } |
---|
150 | |
---|
151 | |
---|
152 | /* Tagline and footer styles ------------------------------------------------- */ |
---|
153 | |
---|
154 | div#tagline { |
---|
155 | margin-top: 6px; |
---|
156 | border-top: 1px dotted lightsteelblue; |
---|
157 | padding-top: 6px; |
---|
158 | font-size: 66%; |
---|
159 | font-style: italic; |
---|
160 | } |
---|
161 | |
---|
162 | div#footer { |
---|
163 | margin-top: 6px; |
---|
164 | border-top: 1px dotted lightsteelblue; |
---|
165 | padding-top: 6px; |
---|
166 | font-size: 66%; |
---|
167 | font-style: italic; |
---|
168 | } |
---|
169 | |
---|
170 | /* Basic data presenation styles -------------------------------------------- */ |
---|
171 | |
---|
172 | .index_letter { |
---|
173 | font-size: 300%; |
---|
174 | font-weight: bold; |
---|
175 | color: #000066; |
---|
176 | margin: 0.5em 0 0 -0.1em; |
---|
177 | } |
---|
178 | |
---|
179 | h1, h2, h3, h4 { |
---|
180 | font-weight: normal; |
---|
181 | color: #3333CC; |
---|
182 | } |
---|
183 | |
---|
184 | h1 { |
---|
185 | padding-top: 0.75em; |
---|
186 | font-size: 160%; |
---|
187 | } |
---|
188 | |
---|
189 | h2 { |
---|
190 | padding-top: 1em; |
---|
191 | font-size: 120%; |
---|
192 | } |
---|
193 | |
---|
194 | h3 { |
---|
195 | padding-top: 0.75em; |
---|
196 | margin-bottom: 0.25em; |
---|
197 | font-size: 100%; |
---|
198 | } |
---|
199 | |
---|
200 | h4 { |
---|
201 | padding: 0; |
---|
202 | margin: 0.5em 0 0 0; |
---|
203 | font-size: 80%; |
---|
204 | } |
---|
205 | |
---|
206 | table.basic { |
---|
207 | empty-cells: show; |
---|
208 | margin: 1.5em 1em 0 1em; |
---|
209 | border: 1px dotted #CFCFFF; |
---|
210 | font-size: 80%; |
---|
211 | } |
---|
212 | |
---|
213 | table.basic th { |
---|
214 | background-color: #F0F0FF; |
---|
215 | font-weight: bold; |
---|
216 | text-align: left; |
---|
217 | padding: 4px 1em 4px 4px; |
---|
218 | border-bottom: 1px dotted #666699; |
---|
219 | } |
---|
220 | |
---|
221 | table.basic td { |
---|
222 | vertical-align: top; |
---|
223 | padding: 4px 1em 4px 4px; |
---|
224 | } |
---|
225 | |
---|
226 | dd { |
---|
227 | margin-bottom: 0.25em; |
---|
228 | font-size: 80%; |
---|
229 | } |
---|
230 | |
---|
231 | |
---|
232 | /* Warnings styles ----------------------------------------------------------- */ |
---|
233 | |
---|
234 | |
---|
235 | #todo dl, #bugs dl { |
---|
236 | margin: 0 0 0 1.5em; |
---|
237 | font-size: 80%; |
---|
238 | } |
---|
239 | |
---|
240 | #todo dd, #bugs dd { |
---|
241 | margin-left: 3em; |
---|
242 | font-size: 100%; |
---|
243 | } |
---|
244 | |
---|
245 | #undoc table, #obsolete table, #statistics table { |
---|
246 | width: 80%; |
---|
247 | margin-left: 2em; |
---|
248 | } |
---|
249 | |
---|
250 | #undoc td, #obsolete td, #statistics td { |
---|
251 | padding: 0 0 0 0; |
---|
252 | font-size: 80%; |
---|
253 | white-space: nowrap; |
---|
254 | } |
---|
255 | |
---|
256 | #undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; } |
---|
257 | |
---|
258 | #undoc td.docstat, #statistics td.stat { |
---|
259 | width: 50%; |
---|
260 | text-align: right; |
---|
261 | } |
---|
262 | |
---|
263 | #undoc td.partialdoc, #statistics td.caution { color: #CC6600; } |
---|
264 | |
---|
265 | #undoc td.notdoc, #statistics td.warning { color: #993333; } |
---|
266 | |
---|
267 | /* File + routine styles ----------------------------------------------------- */ |
---|
268 | |
---|
269 | h1.directory { |
---|
270 | padding: 1em 0 0 0; |
---|
271 | margin: 0; |
---|
272 | font-size: 66%; |
---|
273 | } |
---|
274 | |
---|
275 | h1.directory a { border-bottom: 0; } |
---|
276 | |
---|
277 | h2.pro_file { |
---|
278 | padding: 0; |
---|
279 | margin: 0; |
---|
280 | font-size: 140%; |
---|
281 | } |
---|
282 | |
---|
283 | div#file_attr { |
---|
284 | padding: 0 1em 0 1em; |
---|
285 | margin: 1em; |
---|
286 | background: #F6F6F6; |
---|
287 | border: 1px dotted #999999; |
---|
288 | } |
---|
289 | |
---|
290 | div#file_attr dt { |
---|
291 | font-size: 80%; |
---|
292 | font-weight: bold; |
---|
293 | } |
---|
294 | |
---|
295 | div#file_attr dd { |
---|
296 | font-size: 80%; |
---|
297 | } |
---|
298 | |
---|
299 | div#class_diagram { |
---|
300 | padding: 1em 0 1em 0; |
---|
301 | white-space: pre; |
---|
302 | font-family: 'Courier New'; |
---|
303 | } |
---|
304 | |
---|
305 | table#sav_attr { |
---|
306 | font-size: 90%; |
---|
307 | margin: 1em; |
---|
308 | padding: 1em 1em 1em 1em; |
---|
309 | background: #F6F6F6; |
---|
310 | border: 1px dotted #999999; |
---|
311 | } |
---|
312 | |
---|
313 | table#sav_attr th { text-align: left; } |
---|
314 | |
---|
315 | table#sav_attr td { vertical-align: top; padding-right: 2em; } |
---|
316 | |
---|
317 | table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; } |
---|
318 | |
---|
319 | p.sav_warning { margin-left: 4em; font-family: 80%; } |
---|
320 | |
---|
321 | table.variables { |
---|
322 | font-family: 'Courier New', monospace; |
---|
323 | font-size: 80%; |
---|
324 | text-indent: -2em; |
---|
325 | padding-left: 2em; |
---|
326 | } |
---|
327 | |
---|
328 | table.variables td.image { width: 64px; } |
---|
329 | |
---|
330 | div#file_comments { |
---|
331 | margin: 2em; |
---|
332 | font-size: 80%; |
---|
333 | } |
---|
334 | |
---|
335 | |
---|
336 | div.field_summary { |
---|
337 | padding: 0 1em 0 1em; |
---|
338 | margin: 1em; |
---|
339 | background: #FFFFF0; |
---|
340 | border: 1px dotted #C0C000; |
---|
341 | } |
---|
342 | |
---|
343 | div#routine_summary { |
---|
344 | padding: 0 1em 0 1em; |
---|
345 | margin: 1em; |
---|
346 | background: #F0F0FF; |
---|
347 | border: 1px dotted #9999FF; |
---|
348 | } |
---|
349 | |
---|
350 | div.field_summary h2, div#routine_summary h2 { |
---|
351 | padding: 0.5em 0 0 0; |
---|
352 | margin: 0; |
---|
353 | } |
---|
354 | |
---|
355 | div.field_summary table, div.field_summary p { |
---|
356 | margin: 1em 1em; |
---|
357 | } |
---|
358 | |
---|
359 | div.field_summary td.name { |
---|
360 | vertical-align: top; |
---|
361 | padding-bottom: 0.25em; |
---|
362 | color: #3333CC; |
---|
363 | } |
---|
364 | |
---|
365 | div.field_summary span.field_type { |
---|
366 | font-weight: normal; |
---|
367 | font-size: 80%; |
---|
368 | color: black; |
---|
369 | } |
---|
370 | |
---|
371 | div.field_summary td.comments { |
---|
372 | vertical-align: top; |
---|
373 | padding-left: 2em; |
---|
374 | font-size: 80%; |
---|
375 | } |
---|
376 | |
---|
377 | p.commaList { |
---|
378 | margin: 1em 1em 1em 1em; |
---|
379 | } |
---|
380 | |
---|
381 | span.warning { |
---|
382 | color: #CC6633; |
---|
383 | font-weight: bold; |
---|
384 | font-size: 66%; |
---|
385 | text-transform: uppercase; |
---|
386 | } |
---|
387 | |
---|
388 | span.categories { |
---|
389 | color: #006633; |
---|
390 | font-weight: bold; |
---|
391 | font-size: 66%; |
---|
392 | text-transform: uppercase; |
---|
393 | } |
---|
394 | |
---|
395 | span.undoc { |
---|
396 | color: #FF6633; |
---|
397 | font-weight: bold; |
---|
398 | font-size: 80%; |
---|
399 | text-transform: uppercase; |
---|
400 | } |
---|
401 | |
---|
402 | span.attr { |
---|
403 | color: #006633; |
---|
404 | font-weight: bold; |
---|
405 | font-size: 80%; |
---|
406 | text-transform: uppercase; |
---|
407 | } |
---|
408 | |
---|
409 | span.value { |
---|
410 | color: #006633; |
---|
411 | font-weight: normal; |
---|
412 | text-transform: none; |
---|
413 | } |
---|
414 | |
---|
415 | a.top { |
---|
416 | font-weight: bold; |
---|
417 | font-size: 66%; |
---|
418 | text-transform: uppercase; |
---|
419 | float: right; |
---|
420 | } |
---|
421 | |
---|
422 | span.result { |
---|
423 | font-family: Verdana, Arial, Helvetica, sans-serif; |
---|
424 | font-style: italic; |
---|
425 | font-size: 80%; |
---|
426 | } |
---|
427 | |
---|
428 | div#routine_summary p, div.routine_details p.header { |
---|
429 | padding-top: 0.5em; |
---|
430 | margin-left: 1.5em; |
---|
431 | text-indent: -1.5em; |
---|
432 | font-family: 'Courier New', monospace; |
---|
433 | } |
---|
434 | |
---|
435 | div.routine_details { |
---|
436 | padding: 0.5em 1em 0.5em 1em; |
---|
437 | margin: 1em; |
---|
438 | border: 1px dotted #CCCCCC; |
---|
439 | } |
---|
440 | |
---|
441 | div.routine_details h2 { |
---|
442 | padding-top: 0; |
---|
443 | margin-top: 0; |
---|
444 | } |
---|
445 | |
---|
446 | div.routine_details div.value { |
---|
447 | margin: 0 1em 0 1em; |
---|
448 | font-size: 80%; |
---|
449 | } |
---|
450 | |
---|
451 | div.routine_details div.comments { |
---|
452 | font-size: 80%; |
---|
453 | margin: 0.75em 1em 1em 1em; |
---|
454 | } |
---|
455 | |
---|
456 | div.routine_details div.preformat { |
---|
457 | white-space: pre; |
---|
458 | } |
---|
459 | |
---|
460 | table.statistics { |
---|
461 | font-size: 80%; |
---|
462 | margin-left: 1em; |
---|
463 | } |
---|
464 | |
---|
465 | table.statistics td { |
---|
466 | padding: 0 2em 0 0; |
---|
467 | } |
---|
468 | |
---|
469 | /* Overview styles ----------------------------------------------------------- */ |
---|
470 | |
---|
471 | div.overview { |
---|
472 | width: 100%; |
---|
473 | margin-top: 1em; |
---|
474 | clear: both; |
---|
475 | } |
---|
476 | |
---|
477 | div.overview table { |
---|
478 | empty-cells: show; |
---|
479 | font-size: 90%; |
---|
480 | margin: 1em 1em 1em 1em; |
---|
481 | padding: 1em 0.5em 1em 0.5em; |
---|
482 | background: #F6F6F6; |
---|
483 | border: 1px dotted #999999; |
---|
484 | } |
---|
485 | |
---|
486 | div.overview td { |
---|
487 | padding: 3px 1em 3px 1em; |
---|
488 | } |
---|
489 | |
---|
490 | div.overview td.dir { |
---|
491 | width: 1%; |
---|
492 | vertical-align: top; |
---|
493 | text-align: right; |
---|
494 | padding-right: 1em; |
---|
495 | } |
---|
496 | |
---|
497 | |
---|
498 | /* Navigation list styles for tree structures -------------------------------- */ |
---|
499 | |
---|
500 | #tree { |
---|
501 | text-align: left; |
---|
502 | font-size: 90%; |
---|
503 | margin: 0.75em 0 0.75em 0; |
---|
504 | padding: 0; |
---|
505 | } |
---|
506 | |
---|
507 | #tree ul { |
---|
508 | text-align: left; |
---|
509 | margin: 0; |
---|
510 | padding: 0; |
---|
511 | } |
---|
512 | |
---|
513 | #tree li { |
---|
514 | margin: 0 0 0 15px; |
---|
515 | padding: 0; |
---|
516 | list-style-type: none; |
---|
517 | } |
---|
518 | |
---|
519 | #tree .symbols { |
---|
520 | float: left; |
---|
521 | width: 12px; |
---|
522 | height: 1em; |
---|
523 | padding-left: 4px; |
---|
524 | background-position: 0 100%; |
---|
525 | background-repeat: no-repeat; |
---|
526 | } |
---|
527 | |
---|
528 | /* Search styles ------------------------------------------------------------- */ |
---|
529 | |
---|
530 | input.writein { |
---|
531 | padding-left: 0.5em; |
---|
532 | border: 1px solid #CCCCCC; |
---|
533 | font-family: 'Courier New'; |
---|
534 | background: #FFFFF3; |
---|
535 | } |
---|
536 | |
---|
537 | #search form { |
---|
538 | margin-left: 2em; |
---|
539 | } |
---|
540 | |
---|
541 | #search table { |
---|
542 | margin: 1em 1em 0 2em; |
---|
543 | padding: 1em 2em 1em 2em; |
---|
544 | background: #F6F6F6; |
---|
545 | border: 1px dotted #999999; |
---|
546 | } |
---|
547 | |
---|
548 | #search tr { |
---|
549 | text-align: center; |
---|
550 | } |
---|
551 | |
---|
552 | #search td { |
---|
553 | font-size: 80%; |
---|
554 | text-align: left; |
---|
555 | } |
---|
556 | |
---|
557 | #search td * { |
---|
558 | vertical-align: middle; |
---|
559 | } |
---|
560 | |
---|
561 | #search p { |
---|
562 | font-size: 66%; |
---|
563 | margin: 0 3em 2em 3em; |
---|
564 | } |
---|
565 | |
---|
566 | /* Help styles --------------------------------------------------------------- */ |
---|
567 | |
---|
568 | div.toc { |
---|
569 | padding: 0 1em 0 1em; |
---|
570 | margin: 1em; |
---|
571 | background: #F0F0FF; |
---|
572 | border: 1px dotted #9999FF; |
---|
573 | width: 19em; |
---|
574 | } |
---|
575 | |
---|
576 | div.right { |
---|
577 | float: right; |
---|
578 | width: 22em; |
---|
579 | } |
---|
580 | |
---|
581 | ol.toc { |
---|
582 | list-style-type: upper-roman; |
---|
583 | } |
---|
584 | |
---|
585 | ol.toc ol { |
---|
586 | padding-left: 3em; |
---|
587 | margin-left: 0; |
---|
588 | list-style-type: lower-alpha; |
---|
589 | } |
---|
590 | |
---|
591 | dl.variables dt { font-size: 80%; } |
---|
592 | dl.variables dd { margin-bottom: 0.5em; } |
---|
593 | |
---|
594 | </style> |
---|
595 | <style type="text/css" media="print"> |
---|
596 | #navbar_title { |
---|
597 | background-color: #FFFFFF; |
---|
598 | } |
---|
599 | |
---|
600 | #main_navbar td { |
---|
601 | background: #FFFFFF; |
---|
602 | border-top: 0.25em solid #FFFFFF; |
---|
603 | border-bottom: 0.25em solid #FFFFFF; |
---|
604 | } |
---|
605 | |
---|
606 | #main_navbar td#selected { |
---|
607 | background: #FFFFFF; |
---|
608 | border-top: 0.25em solid #333399; |
---|
609 | border-bottom: 0.25em solid #FFFFFF; |
---|
610 | } |
---|
611 | |
---|
612 | #main_navbar td#flexible { |
---|
613 | background: #FFFFFF; |
---|
614 | border-top: 0.25em solid #FFFFFF; |
---|
615 | border-bottom: 0.25em solid #FFFFFF; |
---|
616 | } |
---|
617 | |
---|
618 | #secondary_navbar { |
---|
619 | display: none; |
---|
620 | } |
---|
621 | |
---|
622 | </style> |
---|
623 | |
---|
624 | |
---|
625 | <script type="text/javascript"> |
---|
626 | function setTitle() { |
---|
627 | parent.document.title="checkfield.pro (SAXO Documentation)"; |
---|
628 | } |
---|
629 | </script> |
---|
630 | </head> |
---|
631 | |
---|
632 | <body onload="setTitle();"> |
---|
633 | |
---|
634 | <div id="navbar_title"> |
---|
635 | <h1>SAXO Documentation</h1> |
---|
636 | </div> |
---|
637 | |
---|
638 | |
---|
639 | <div id="main_navbar"> |
---|
640 | |
---|
641 | <table cellspacing="0"> |
---|
642 | <tr> |
---|
643 | |
---|
644 | <td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td> |
---|
645 | |
---|
646 | |
---|
647 | |
---|
648 | <td >Directory</td> |
---|
649 | |
---|
650 | |
---|
651 | |
---|
652 | <td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
653 | |
---|
654 | |
---|
655 | |
---|
656 | <td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
657 | |
---|
658 | |
---|
659 | |
---|
660 | <td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td> |
---|
661 | |
---|
662 | |
---|
663 | <td id="selected">File</td> |
---|
664 | |
---|
665 | |
---|
666 | <td >Source</td> |
---|
667 | |
---|
668 | |
---|
669 | |
---|
670 | <td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> |
---|
671 | |
---|
672 | |
---|
673 | <td >Etc</td> |
---|
674 | |
---|
675 | <td id="flexible">Developer documentation</td> |
---|
676 | </tr> |
---|
677 | </table> |
---|
678 | |
---|
679 | </div> |
---|
680 | |
---|
681 | <div id="secondary_navbar"> |
---|
682 | |
---|
683 | <a href="barrecouleur.html?format=raw"><<prev file</a> | <a href="checktypeminmax.html?format=raw">next file >></a> <a href="checkfield.html?format=raw" target="_TOP">view single page</a> | <a href="./../../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> details: <a href="#routine_details">routine</a> |
---|
684 | |
---|
685 | </div> |
---|
686 | |
---|
687 | |
---|
688 | <div id="container"> |
---|
689 | |
---|
690 | <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/PLOTS/DIVERS/</a></h1> |
---|
691 | <h2 class="pro_file">checkfield.pro</h2> |
---|
692 | |
---|
693 | <div id="file_attr"> |
---|
694 | <dl> |
---|
695 | </dl> |
---|
696 | </div> |
---|
697 | |
---|
698 | <div id="file_comments"></div> |
---|
699 | |
---|
700 | |
---|
701 | |
---|
702 | |
---|
703 | |
---|
704 | |
---|
705 | |
---|
706 | |
---|
707 | <div id="routine_summary"> |
---|
708 | <h2>Routine summary</h2> |
---|
709 | |
---|
710 | <dl> |
---|
711 | |
---|
712 | <dt><p><a href="#_err_1d"><span class="result">result = </span>err_1d(<span class="result">type, n1, name, n2</span>)</a></p><dt> |
---|
713 | <dd> NAME:checkfield PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le champ donne a bien une taille compatible avec le domaine et fait au besoin les moyennes pour ressortir en fin de fonction un tableau 2d si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'.</dd> |
---|
714 | |
---|
715 | <dt><p><a href="#_err_2d"><span class="result">result = </span>err_2d(<span class="result">type, sz, nx, ny, nz</span>)</a></p><dt> |
---|
716 | <dd></dd> |
---|
717 | |
---|
718 | <dt><p><a href="#_err_3d"><span class="result">result = </span>err_3d(<span class="result">type, sz, nx, ny, nz</span>)</a></p><dt> |
---|
719 | <dd></dd> |
---|
720 | |
---|
721 | <dt><p><a href="#_checkfield"><span class="result">result = </span>checkfield(<span class="result">field, procedure</span>, TYPE=<span class="result">TYPE</span>, BOXZOOM=<span class="result">BOXZOOM</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">VECTEUR</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt> |
---|
722 | <dd></dd> |
---|
723 | |
---|
724 | </dl> |
---|
725 | </div> |
---|
726 | |
---|
727 | |
---|
728 | <div id="routine_details"> |
---|
729 | |
---|
730 | |
---|
731 | <div class="routine_details" id="_err_1d"> |
---|
732 | |
---|
733 | <h2><a class="top" href="#container">top</a>err_1d </h2> |
---|
734 | |
---|
735 | <p class="header"> |
---|
736 | <span class="result">result = </span>err_1d(<span class="result"><a href="#_err_1d_param_type">type</a>, <a href="#_err_1d_param_n1">n1</a>, <a href="#_err_1d_param_name">name</a>, <a href="#_err_1d_param_n2">n2</a></span>)</p> |
---|
737 | |
---|
738 | <div class="comments"> |
---|
739 | NAME:checkfield |
---|
740 | |
---|
741 | PURPOSE:en entree de plt, pltz, pltt et plt1d, verifie que le |
---|
742 | champ donne a bien une taille compatible avec le domaine et fait au |
---|
743 | besoin les moyennes pour ressortir en fin de fonction un tableau 2d |
---|
744 | si on fait un plot du type: 'xy', 'xz', 'xt', 'yz', 'yt', 'zt' ou un |
---|
745 | tableau 1d si on fait un plot du type 'x', 'y', 'z', 't'. |
---|
746 | |
---|
747 | CATEGORY:en entree de plt, pltz, pltt et plt1d |
---|
748 | |
---|
749 | CALLING SEQUENCE:res=checkfield(field, procedure) |
---|
750 | |
---|
751 | INPUTS: |
---|
752 | filed: un champ recomdant aux criteres de litchamp.pro, cf. |
---|
753 | IDL>xhelp,'litchamp' |
---|
754 | |
---|
755 | KEYWORD PARAMETERS: |
---|
756 | |
---|
757 | /WDEPTH: to specify that the field is at W depth instad of T |
---|
758 | depth (automatically activated if vargrid eq 'W') |
---|
759 | |
---|
760 | OUTPUTS: |
---|
761 | |
---|
762 | COMMON BLOCKS:common.pro |
---|
763 | |
---|
764 | SIDE EFFECTS: |
---|
765 | |
---|
766 | RESTRICTIONS: |
---|
767 | |
---|
768 | EXAMPLE: |
---|
769 | </div> |
---|
770 | |
---|
771 | |
---|
772 | |
---|
773 | |
---|
774 | <h3>Parameters</h3> |
---|
775 | |
---|
776 | |
---|
777 | <h4 id="_err_1d_param_type">type |
---|
778 | |
---|
779 | |
---|
780 | |
---|
781 | |
---|
782 | |
---|
783 | |
---|
784 | |
---|
785 | |
---|
786 | </h4> |
---|
787 | |
---|
788 | <div class="comments"></div> |
---|
789 | |
---|
790 | <h4 id="_err_1d_param_n1">n1 |
---|
791 | |
---|
792 | |
---|
793 | |
---|
794 | |
---|
795 | |
---|
796 | |
---|
797 | |
---|
798 | |
---|
799 | </h4> |
---|
800 | |
---|
801 | <div class="comments"></div> |
---|
802 | |
---|
803 | <h4 id="_err_1d_param_name">name |
---|
804 | |
---|
805 | |
---|
806 | |
---|
807 | |
---|
808 | |
---|
809 | |
---|
810 | |
---|
811 | |
---|
812 | </h4> |
---|
813 | |
---|
814 | <div class="comments"></div> |
---|
815 | |
---|
816 | <h4 id="_err_1d_param_n2">n2 |
---|
817 | |
---|
818 | |
---|
819 | |
---|
820 | |
---|
821 | |
---|
822 | |
---|
823 | |
---|
824 | |
---|
825 | </h4> |
---|
826 | |
---|
827 | <div class="comments"></div> |
---|
828 | |
---|
829 | |
---|
830 | |
---|
831 | |
---|
832 | |
---|
833 | |
---|
834 | |
---|
835 | |
---|
836 | |
---|
837 | |
---|
838 | |
---|
839 | |
---|
840 | |
---|
841 | |
---|
842 | |
---|
843 | |
---|
844 | |
---|
845 | |
---|
846 | |
---|
847 | |
---|
848 | |
---|
849 | |
---|
850 | |
---|
851 | |
---|
852 | |
---|
853 | |
---|
854 | |
---|
855 | |
---|
856 | |
---|
857 | </div> |
---|
858 | |
---|
859 | |
---|
860 | <div class="routine_details" id="_err_2d"> |
---|
861 | |
---|
862 | <h2><a class="top" href="#container">top</a>err_2d </h2> |
---|
863 | |
---|
864 | <p class="header"> |
---|
865 | <span class="result">result = </span>err_2d(<span class="result"><a href="#_err_2d_param_type">type</a>, <a href="#_err_2d_param_sz">sz</a>, <a href="#_err_2d_param_nx">nx</a>, <a href="#_err_2d_param_ny">ny</a>, <a href="#_err_2d_param_nz">nz</a></span>)</p> |
---|
866 | |
---|
867 | <div class="comments"></div> |
---|
868 | |
---|
869 | |
---|
870 | |
---|
871 | |
---|
872 | <h3>Parameters</h3> |
---|
873 | |
---|
874 | |
---|
875 | <h4 id="_err_2d_param_type">type |
---|
876 | |
---|
877 | |
---|
878 | |
---|
879 | |
---|
880 | |
---|
881 | |
---|
882 | |
---|
883 | |
---|
884 | </h4> |
---|
885 | |
---|
886 | <div class="comments"></div> |
---|
887 | |
---|
888 | <h4 id="_err_2d_param_sz">sz |
---|
889 | |
---|
890 | |
---|
891 | |
---|
892 | |
---|
893 | |
---|
894 | |
---|
895 | |
---|
896 | |
---|
897 | </h4> |
---|
898 | |
---|
899 | <div class="comments"></div> |
---|
900 | |
---|
901 | <h4 id="_err_2d_param_nx">nx |
---|
902 | |
---|
903 | |
---|
904 | |
---|
905 | |
---|
906 | |
---|
907 | |
---|
908 | |
---|
909 | |
---|
910 | </h4> |
---|
911 | |
---|
912 | <div class="comments"></div> |
---|
913 | |
---|
914 | <h4 id="_err_2d_param_ny">ny |
---|
915 | |
---|
916 | |
---|
917 | |
---|
918 | |
---|
919 | |
---|
920 | |
---|
921 | |
---|
922 | |
---|
923 | </h4> |
---|
924 | |
---|
925 | <div class="comments"></div> |
---|
926 | |
---|
927 | <h4 id="_err_2d_param_nz">nz |
---|
928 | |
---|
929 | |
---|
930 | |
---|
931 | |
---|
932 | |
---|
933 | |
---|
934 | |
---|
935 | |
---|
936 | </h4> |
---|
937 | |
---|
938 | <div class="comments"></div> |
---|
939 | |
---|
940 | |
---|
941 | |
---|
942 | |
---|
943 | |
---|
944 | |
---|
945 | |
---|
946 | |
---|
947 | |
---|
948 | |
---|
949 | |
---|
950 | |
---|
951 | |
---|
952 | |
---|
953 | |
---|
954 | |
---|
955 | |
---|
956 | |
---|
957 | |
---|
958 | |
---|
959 | |
---|
960 | |
---|
961 | |
---|
962 | |
---|
963 | |
---|
964 | |
---|
965 | |
---|
966 | |
---|
967 | |
---|
968 | </div> |
---|
969 | |
---|
970 | |
---|
971 | <div class="routine_details" id="_err_3d"> |
---|
972 | |
---|
973 | <h2><a class="top" href="#container">top</a>err_3d </h2> |
---|
974 | |
---|
975 | <p class="header"> |
---|
976 | <span class="result">result = </span>err_3d(<span class="result"><a href="#_err_3d_param_type">type</a>, <a href="#_err_3d_param_sz">sz</a>, <a href="#_err_3d_param_nx">nx</a>, <a href="#_err_3d_param_ny">ny</a>, <a href="#_err_3d_param_nz">nz</a></span>)</p> |
---|
977 | |
---|
978 | <div class="comments"></div> |
---|
979 | |
---|
980 | |
---|
981 | |
---|
982 | |
---|
983 | <h3>Parameters</h3> |
---|
984 | |
---|
985 | |
---|
986 | <h4 id="_err_3d_param_type">type |
---|
987 | |
---|
988 | |
---|
989 | |
---|
990 | |
---|
991 | |
---|
992 | |
---|
993 | |
---|
994 | |
---|
995 | </h4> |
---|
996 | |
---|
997 | <div class="comments"></div> |
---|
998 | |
---|
999 | <h4 id="_err_3d_param_sz">sz |
---|
1000 | |
---|
1001 | |
---|
1002 | |
---|
1003 | |
---|
1004 | |
---|
1005 | |
---|
1006 | |
---|
1007 | |
---|
1008 | </h4> |
---|
1009 | |
---|
1010 | <div class="comments"></div> |
---|
1011 | |
---|
1012 | <h4 id="_err_3d_param_nx">nx |
---|
1013 | |
---|
1014 | |
---|
1015 | |
---|
1016 | |
---|
1017 | |
---|
1018 | |
---|
1019 | |
---|
1020 | |
---|
1021 | </h4> |
---|
1022 | |
---|
1023 | <div class="comments"></div> |
---|
1024 | |
---|
1025 | <h4 id="_err_3d_param_ny">ny |
---|
1026 | |
---|
1027 | |
---|
1028 | |
---|
1029 | |
---|
1030 | |
---|
1031 | |
---|
1032 | |
---|
1033 | |
---|
1034 | </h4> |
---|
1035 | |
---|
1036 | <div class="comments"></div> |
---|
1037 | |
---|
1038 | <h4 id="_err_3d_param_nz">nz |
---|
1039 | |
---|
1040 | |
---|
1041 | |
---|
1042 | |
---|
1043 | |
---|
1044 | |
---|
1045 | |
---|
1046 | |
---|
1047 | </h4> |
---|
1048 | |
---|
1049 | <div class="comments"></div> |
---|
1050 | |
---|
1051 | |
---|
1052 | |
---|
1053 | |
---|
1054 | |
---|
1055 | |
---|
1056 | |
---|
1057 | |
---|
1058 | |
---|
1059 | |
---|
1060 | |
---|
1061 | |
---|
1062 | |
---|
1063 | |
---|
1064 | |
---|
1065 | |
---|
1066 | |
---|
1067 | |
---|
1068 | |
---|
1069 | |
---|
1070 | |
---|
1071 | |
---|
1072 | |
---|
1073 | |
---|
1074 | |
---|
1075 | |
---|
1076 | |
---|
1077 | |
---|
1078 | |
---|
1079 | </div> |
---|
1080 | |
---|
1081 | |
---|
1082 | <div class="routine_details" id="_checkfield"> |
---|
1083 | |
---|
1084 | <h2><a class="top" href="#container">top</a>checkfield </h2> |
---|
1085 | |
---|
1086 | <p class="header"> |
---|
1087 | <span class="result">result = </span>checkfield(<span class="result"><a href="#_checkfield_param_field">field</a>, <a href="#_checkfield_param_procedure">procedure</a></span>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<span class="result">NOQUESTION</span>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
---|
1088 | |
---|
1089 | <div class="comments"></div> |
---|
1090 | |
---|
1091 | |
---|
1092 | |
---|
1093 | |
---|
1094 | <h3>Parameters</h3> |
---|
1095 | |
---|
1096 | |
---|
1097 | <h4 id="_checkfield_param_field">field |
---|
1098 | |
---|
1099 | |
---|
1100 | |
---|
1101 | |
---|
1102 | |
---|
1103 | |
---|
1104 | |
---|
1105 | |
---|
1106 | </h4> |
---|
1107 | |
---|
1108 | <div class="comments"></div> |
---|
1109 | |
---|
1110 | <h4 id="_checkfield_param_procedure">procedure |
---|
1111 | |
---|
1112 | |
---|
1113 | |
---|
1114 | |
---|
1115 | |
---|
1116 | |
---|
1117 | |
---|
1118 | |
---|
1119 | </h4> |
---|
1120 | |
---|
1121 | <div class="comments"></div> |
---|
1122 | |
---|
1123 | |
---|
1124 | |
---|
1125 | |
---|
1126 | |
---|
1127 | |
---|
1128 | <h3>Keywords</h3> |
---|
1129 | |
---|
1130 | <h4 id="_checkfield_keyword_TYPE">TYPE |
---|
1131 | |
---|
1132 | |
---|
1133 | |
---|
1134 | |
---|
1135 | |
---|
1136 | |
---|
1137 | |
---|
1138 | |
---|
1139 | </h4> |
---|
1140 | |
---|
1141 | <div class="comments"></div> |
---|
1142 | |
---|
1143 | <h4 id="_checkfield_keyword_BOXZOOM">BOXZOOM |
---|
1144 | |
---|
1145 | |
---|
1146 | |
---|
1147 | |
---|
1148 | |
---|
1149 | |
---|
1150 | |
---|
1151 | |
---|
1152 | </h4> |
---|
1153 | |
---|
1154 | <div class="comments"></div> |
---|
1155 | |
---|
1156 | <h4 id="_checkfield_keyword_DIREC">DIREC |
---|
1157 | |
---|
1158 | |
---|
1159 | |
---|
1160 | |
---|
1161 | |
---|
1162 | |
---|
1163 | |
---|
1164 | |
---|
1165 | </h4> |
---|
1166 | |
---|
1167 | <div class="comments"></div> |
---|
1168 | |
---|
1169 | <h4 id="_checkfield_keyword_NOQUESTION">NOQUESTION |
---|
1170 | |
---|
1171 | |
---|
1172 | |
---|
1173 | |
---|
1174 | |
---|
1175 | |
---|
1176 | |
---|
1177 | |
---|
1178 | </h4> |
---|
1179 | |
---|
1180 | <div class="comments"></div> |
---|
1181 | |
---|
1182 | <h4 id="_checkfield_keyword_VECTEUR">VECTEUR |
---|
1183 | |
---|
1184 | |
---|
1185 | |
---|
1186 | |
---|
1187 | |
---|
1188 | |
---|
1189 | |
---|
1190 | |
---|
1191 | </h4> |
---|
1192 | |
---|
1193 | <div class="comments"></div> |
---|
1194 | |
---|
1195 | <h4 id="_checkfield_keyword_WDEPTH">WDEPTH |
---|
1196 | |
---|
1197 | |
---|
1198 | |
---|
1199 | |
---|
1200 | |
---|
1201 | |
---|
1202 | |
---|
1203 | |
---|
1204 | </h4> |
---|
1205 | |
---|
1206 | <div class="comments"></div> |
---|
1207 | |
---|
1208 | <h4 id="_checkfield_keyword__EXTRA">_EXTRA |
---|
1209 | |
---|
1210 | |
---|
1211 | |
---|
1212 | |
---|
1213 | |
---|
1214 | |
---|
1215 | |
---|
1216 | |
---|
1217 | </h4> |
---|
1218 | |
---|
1219 | <div class="comments"></div> |
---|
1220 | |
---|
1221 | |
---|
1222 | |
---|
1223 | |
---|
1224 | |
---|
1225 | |
---|
1226 | |
---|
1227 | |
---|
1228 | |
---|
1229 | |
---|
1230 | |
---|
1231 | |
---|
1232 | |
---|
1233 | |
---|
1234 | |
---|
1235 | |
---|
1236 | |
---|
1237 | |
---|
1238 | |
---|
1239 | |
---|
1240 | |
---|
1241 | |
---|
1242 | |
---|
1243 | |
---|
1244 | |
---|
1245 | |
---|
1246 | </div> |
---|
1247 | |
---|
1248 | </div> |
---|
1249 | |
---|
1250 | |
---|
1251 | |
---|
1252 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
1253 | |
---|
1254 | </div> |
---|
1255 | |
---|
1256 | </body> |
---|
1257 | </html> |
---|