source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/where_tag.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

update documentation
File size: 6.9 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>where_tag.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="where_tag.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/STRUCTURE//where_tag.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="struct2string.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="where_tag.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;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/STRUCTURE/</a></h1>
82      <h2 class="pro_file">where_tag.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Like WHERE but works on structure tag names
91 Obtain subscripts of elements in structure array for which
92 a particular Tag has values in a range or matching specified values.
93 Like the WHERE function but for use with structures
94 </div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_where_tag">
108
109          <h2><a class="top" href="#container">top</a>where_tag <span class="categories">
110 Structure
111</span></h2>
112       
113          <p class="header">
114            <span class="result">result = </span>where_tag(<span class="result"><a href="#_where_tag_param_Struct">Struct</a>, <a href="#_where_tag_param_Nfound">Nfound</a></span>, <a href="#_where_tag_keyword_TAG_NAME">TAG_NAME</a>=<span class="result">TAG_NAME</span>, <a href="#_where_tag_keyword_TAG_NUMBER">TAG_NUMBER</a>=<span class="result">TAG_NUMBER</span>, <a href="#_where_tag_keyword_ISELECT">ISELECT</a>=<span class="result">ISELECT</span>, <a href="#_where_tag_keyword_NOPRINT">NOPRINT</a>=<span class="result">NOPRINT</span>, <a href="#_where_tag_keyword_RANGE">RANGE</a>=<span class="result">RANGE</span>, <a href="#_where_tag_keyword_VALUES">VALUES</a>=<span class="result">VALUES</span>)</p>
115       
116          <div class="comments">
117</div>
118
119          <h3>Return value</h3><div class="preformat">
120 Nfound {out}
121 # of occurrences found.
122 </div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_where_tag_param_Struct">Struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134             
135             
136             
137            </h4>
138       
139          <div class="comments">
140 structure array to search.
141</div>
142           
143            <h4 id="_where_tag_param_Nfound">Nfound&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144             
145             
146             
147             
148             
149             
150             
151             
152            </h4>
153       
154          <div class="comments"></div>
155           
156
157         
158
159         
160
161            <h3>Keywords</h3>
162           
163            <h4 id="_where_tag_keyword_TAG_NAME">TAG_NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174            <div class="comments">
175 Scalar string specifying Tag Name
176 </div>
177           
178            <h4 id="_where_tag_keyword_TAG_NUMBER">TAG_NUMBER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189            <div class="comments">
190 Otherwise give the Tag Number,
191 </div>
192           
193            <h4 id="_where_tag_keyword_ISELECT">ISELECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194             
195             
196             
197             
198             
199             
200             
201             
202            </h4>
203       
204            <div class="comments">
205 Specifies indices to select only part of structure array,
206 (use it to recycle subscripts from previous searches).
207 </div>
208           
209            <h4 id="_where_tag_keyword_NOPRINT">NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210             
211             
212             
213             
214             
215             
216             
217             
218            </h4>
219       
220            <div class="comments">
221 Suppress informational messages about nothing found.
222</div>
223           
224            <h4 id="_where_tag_keyword_RANGE">RANGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments">
236  [min,max] range to search for in Struct
237 </div>
238           
239            <h4 id="_where_tag_keyword_VALUES">VALUES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240             
241             
242             
243             
244             
245             
246             
247             
248            </h4>
249       
250            <div class="comments">
251 One or array of numbers to match for in Struct,
252 </div>
253           
254         
255
256          <h3>Examples</h3><div class="preformat">
257       Suppose STR is a structure with tags CAT_NO:indgen(10), and
258               NAME:strarr(10).   Find the indices where STR.CAT_NO is
259               between 3 and 5.
260
261       IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] )  ;or
262       IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5])
263</div>
264          <h3>Version history</h3>
265         
266          <h4>Version</h4><div class="preformat">
267 $Id: where_tag.pro 262 2007-08-21 14:19:32Z pinsard $
268 </div>
269          <h4>History</h4><div class="preformat">
270       written 1990 Frank Varosi STX @ NASA/GSFC
271       Stop printing "Tag <xxx> not found" with /NOPRINT, CD Pike 8-Jun-93
272</div>
273         
274         
275          <h3>Known issues</h3>
276         
277         
278         
279          <h4>Restrictions</h4><div class="preformat">
280 User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2)
281 the VALUES or RANGE to search on;
282</div>
283       
284         
285         
286         
287         
288         
289         
290         
291       
292          <h3>Statistics</h3>
293          <table class="statistics">
294            <tr><td>McCabe cyclic</td><td>          26</td></tr>
295            <tr><td>McCabe essential</td><td>           1</td></tr>
296            <tr><td>McCabe modular design</td><td>           1</td></tr>
297          </table>
298         
299       
300        </div>
301       
302      </div>
303
304     
305
306      <div id="tagline">Produced by IDLdoc 2.0.</div>
307
308    </div>
309
310  </body>
311</html>
Note: See TracBrowser for help on using the repository browser.