source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRUCTURE/chkstru.html @ 168

Last change on this file since 168 was 168, checked in by pinsard, 18 years ago

Main document available on top directory, Source links available in idldoc html output
File size: 5.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>chkstru.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href=""><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="extractstru.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRUCTURE/</font></h1>
58    <h2>chkstru.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 check validity of a structure and test if necessary
65 fields are contained
66
67
68   
69
70     
71      <a name="#_chkstru"></a>
72
73      <h2>chkstru  <font size="-1" color="#006633">
74 Utilities
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>chkstru(<i><a href="#_chkstru_keyword_structure">structure</a>, <a href="#_chkstru_keyword_fields">fields</a></i>, <a href="#_chkstru_keyword_index">index</a>=<i>string</i>, <a href="#_chkstru_keyword_verbose">verbose</a>=<i>verbose</i>, <a href="#_chkstru_keyword_extract">extract</a>=<i>extract</i>)</font></p>
78
79   
80
81    <h3>Return value</h3>
82 CHKSTRU returns 1 if successful, otherwise 0.
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_chkstru_keyword_structure"></a>
90    <h4>structure&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>struct</i></font>
97     
98     
99    </h4>
100
101   
102 The structure to be tested. If STRUCTURE is
103 not of type structure, the function will return 0
104
105   
106
107    <a name="#_chkstru_keyword_fields"></a>
108    <h4>fields&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
115     
116     
117    </h4>
118
119   
120 A string or string array with field names to
121 be contained in STRUCTURE. CHKSTRU returns 1 (true)
122 only if all field names are contained in STRUCTURE.
123 The entries of FIELDS may be upper or lowercase.
124
125   
126   
127
128   
129    <h3>Keywords</h3>
130
131   
132    <a name="#_chkstru_keyword_index"></a>
133    <h4>index&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
140     
141     
142    </h4>
143
144   
145 A named variable that will contain the indices of
146 the required field names in the structure. They can then
147 be assessed through structure.(index[i]) . Index will
148 contain -1 for all fields entries that are not in the
149 structure.
150
151   
152    <a name="#_chkstru_keyword_verbose"></a>
153    <h4>verbose&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154     
155     
156     
157     
158     
159     
160     
161     
162    </h4>
163
164   
165 set this keyword to return an error message
166 in case of an error.
167
168   
169    <a name="#_chkstru_keyword_extract"></a>
170    <h4>extract&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171     
172     
173     
174     
175     
176     
177     
178     
179    </h4>
180
181   
182 set this keyword to extract a fields from the
183 structure.  -1 is return is fields or structure. are
184 incorrect.
185
186   
187   
188
189    <h3>Examples</h3>
190        test = { a:1, b:2, c:3 }
191        required = ['a','c']
192        if CHKSTRU(test,required) then print,'found a and c.'
193        IDL> print, CHKSTRU(test,'b')
194           1
195        IDL> print, CHKSTRU(test,'b',/extract)
196               2
197
198    <h3>Version history</h3>
199   
200    <h4>Version</h4>
201 $Id: chkstru.pro 163 2006-08-29 12:59:46Z navarro $
202
203    <h4>History</h4>
204        mgs, 02 Mar 1998: VERSION 1.00
205        mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
206        12 Jan 2001: EXTRACT keyword by S. Masson (smasson@lodyc.jussieu.fr)
207
208   
209
210   
211   
212   
213   
214   
215
216   
217   
218   
219   
220   
221   
222   
223
224    <font size="-3"><p>&nbsp;</p></font>
225    <hr size="1" color="#CCCCCC"/>
226     
227
228   
229
230    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep  6 12:28:19 2006.</font></p>
231
232  </body>
233</html>
Note: See TracBrowser for help on using the repository browser.