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

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

update documentation
File size: 7.0 KB
RevLine 
[89]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>
[104]9    <title>where_tag.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="where_tag.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/STRUCTURE//where_tag.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STRUCTURE/</a></h1>
[89]82      <h2 class="pro_file">where_tag.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[151]89      <div id="file_comments">
[402]90 Like <a href="/Applications/itt/idl64/help/online_help/WHERE.html">WHERE</a> but works on structure tag names
91
[151]92 Obtain subscripts of elements in structure array for which
93 a particular Tag has values in a range or matching specified values.
[402]94
95 Like the <a href="/Applications/itt/idl64/help/online_help/WHERE.html">WHERE</a> function but for use with structures
[151]96 </div>
[89]97
98     
99
100     
101
102     
103
104     
105
106      <div id="routine_details">
107       
108
[163]109        <div class="routine_details" id="_where_tag">
[89]110
[163]111          <h2><a class="top" href="#container">top</a>where_tag <span class="categories">
[157]112 Structure
[151]113</span></h2>
[89]114       
115          <p class="header">
[163]116            <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>
[89]117       
[234]118          <div class="comments">
119</div>
[89]120
[151]121          <h3>Return value</h3><div class="preformat">
122 Nfound {out}
[163]123 # of occurrences found.
[151]124 </div>
[97]125
[89]126         
127            <h3>Parameters</h3>
128       
129           
[163]130            <h4 id="_where_tag_param_Struct">Struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[151]131              <span class="attr">in</span>
[89]132             
133             
[151]134              <span class="attr">required</span>
[89]135             
136             
137             
138             
139            </h4>
140       
[151]141          <div class="comments">
142 structure array to search.
143</div>
[89]144           
[163]145            <h4 id="_where_tag_param_Nfound">Nfound&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]146             
147             
148             
149             
150             
151             
152             
153             
154            </h4>
155       
156          <div class="comments"></div>
157           
158
159         
160
161         
162
163            <h3>Keywords</h3>
164           
[163]165            <h4 id="_where_tag_keyword_TAG_NAME">TAG_NAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
[151]176            <div class="comments">
177 Scalar string specifying Tag Name
178 </div>
[89]179           
[163]180            <h4 id="_where_tag_keyword_TAG_NUMBER">TAG_NUMBER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]181             
182             
183             
184             
185             
186             
187             
188             
189            </h4>
190       
[151]191            <div class="comments">
[402]192 Otherwise give the Tag Number
[151]193 </div>
[89]194           
[163]195            <h4 id="_where_tag_keyword_ISELECT">ISELECT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
[151]206            <div class="comments">
207 Specifies indices to select only part of structure array,
208 (use it to recycle subscripts from previous searches).
209 </div>
[89]210           
[163]211            <h4 id="_where_tag_keyword_NOPRINT">NOPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]212             
213             
214             
215             
216             
217             
218             
219             
220            </h4>
221       
[151]222            <div class="comments">
223 Suppress informational messages about nothing found.
224</div>
[89]225           
[163]226            <h4 id="_where_tag_keyword_RANGE">RANGE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]227             
228             
229             
230             
231             
232             
233             
234             
235            </h4>
236       
[151]237            <div class="comments">
[402]238 [min,max] range to search for in STRUCT
[151]239 </div>
[89]240           
[163]241            <h4 id="_where_tag_keyword_VALUES">VALUES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]242             
243             
244             
245             
246             
247             
248             
249             
250            </h4>
251       
[151]252            <div class="comments">
[402]253 One or array of numbers to match for in STRUCT
[151]254 </div>
[89]255           
256         
257
[151]258          <h3>Examples</h3><div class="preformat">
259
[402]260 Suppose STR is a structure with tags CAT_NO:indgen(10), and
261 NAME:strarr(10). Find the indices where STR.CAT_NO is between 3 and 5.
262
263   IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] )
264 or
265   IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5])
[151]266</div>
267          <h3>Version history</h3>
[89]268         
[151]269          <h4>Version</h4><div class="preformat">
[402]270 $Id: where_tag.pro 375 2008-08-08 15:55:40Z pinsard $
[151]271 </div>
272          <h4>History</h4><div class="preformat">
273       written 1990 Frank Varosi STX @ NASA/GSFC
274       Stop printing "Tag <xxx> not found" with /NOPRINT, CD Pike 8-Jun-93
275</div>
[89]276         
277         
[151]278          <h3>Known issues</h3>
[89]279         
280         
281         
[151]282          <h4>Restrictions</h4><div class="preformat">
283 User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2)
[402]284 the VALUES or RANGE to search on.
[151]285</div>
[89]286       
287         
288         
289         
290         
291         
292         
293         
294       
[163]295          <h3>Statistics</h3>
296          <table class="statistics">
297            <tr><td>McCabe cyclic</td><td>          26</td></tr>
298            <tr><td>McCabe essential</td><td>           1</td></tr>
299            <tr><td>McCabe modular design</td><td>           1</td></tr>
300          </table>
[89]301         
302       
303        </div>
304       
305      </div>
306
307     
308
309      <div id="tagline">Produced by IDLdoc 2.0.</div>
310
311    </div>
312
313  </body>
[249]314</html>
Note: See TracBrowser for help on using the repository browser.