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

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

update documentation
File size: 5.5 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 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.
122
123 CHKSTRU returns 1 (true) only if all field names are contained in STRUCTURE.
124
125 The entries of FIELDS may be upper or lowercase.
126
127   
128   
129
130   
131    <h3>Keywords</h3>
132
133   
134    <a name="#_chkstru_keyword_INDEX"></a>
135    <h4>INDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136     
137     
138     
139     
140     
141      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
142     
143     
144    </h4>
145
146   
147 A named variable that will contain the indices of
148 the required field names in the structure.
149
150 They can then be assessed through structure.(index[i]).
151
152 Index will contain -1 for all fields entries that are not in the structure.
153
154   
155    <a name="#_chkstru_keyword_VERBOSE"></a>
156    <h4>VERBOSE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157     
158     
159     
160     
161     
162     
163     
164     
165    </h4>
166
167   
168 set this keyword to return an error message in case of an error.
169
170   
171    <a name="#_chkstru_keyword_EXTRACT"></a>
172    <h4>EXTRACT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173     
174     
175     
176     
177     
178     
179     
180     
181    </h4>
182
183   
184 set this keyword to extract a field from the structure. 
185 -1 is return if field or structure are incorrect.
186
187   
188   
189
190    <h3>Examples</h3><pre>
191
192   IDL> test = { a:1, b:2, c:3 }
193   IDL> required = ['a','c']
194   IDL> if CHKSTRU(test,required) then print,'found a and c.'
195   IDL> print, CHKSTRU(test,'b')
196           1
197   IDL> print, CHKSTRU(test,'b',/extract)
198               2
199
200    </pre><h3>Version history</h3>
201   
202    <h4>Version</h4>
203 $Id: chkstru.pro 375 2008-08-08 15:55:40Z pinsard $
204
205 Copyright (C) 1998, Martin Schultz, Harvard University
206 This software is provided as is without any warranty
207 whatsoever. It may be freely used, copied or distributed
208 for non-commercial purposes. This copyright notice must be
209 kept with any copy of this software. If this software shall
210 be used commercially or sold as part of a larger package,
211 please contact the author to arrange payment.
212 Bugs and comments should be directed to mgs@io.harvard.edu
213 with subject "IDL routine chkstru"
214
215    <h4>History</h4>
216  - mgs, 02 Mar 1998: VERSION 1.00
217  - mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
218  - 12 Jan 2001: EXTRACT keyword by S. Masson (smasson@lodyc.jussieu.fr)
219
220   
221
222   
223   
224   
225   
226   
227
228   
229   
230   
231   
232   
233   
234   
235
236    <font size="-3"><p>&nbsp;</p></font>
237    <hr size="1" color="#CCCCCC"/>
238     
239
240   
241
242    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
243
244  </body>
245</html>
Note: See TracBrowser for help on using the repository browser.