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

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

update documentation
File size: 5.8 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>extractstru.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="extractstru.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//extractstru.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="chkstru.html">&lt;&lt;prev file</a> | <a href="mixstru.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extractstru.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">extractstru.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 extract elements of a structure to constitute a new structure.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_extractstru">
105
106          <h2><a class="top" href="#container">top</a>extractstru <span class="categories">
107 Utilities
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>extractstru(<span class="result"><a href="#_extractstru_param_stru">stru</a>, <a href="#_extractstru_param_liste">liste</a></span>, <a href="#_extractstru_keyword_KEEP">KEEP</a>=<span class="result">KEEP</span>, <a href="#_extractstru_keyword_DELETE">DELETE</a>=<span class="result">DELETE</span>)</p>
112       
113          <div class="comments"></div>
114
115          <h3>Return value</h3><div class="preformat">
116 A structure or -1 in case of problem
117</div>
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_extractstru_param_stru">stru&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127              <span class="attr">required</span>
128             
129             
130             
131             
132            </h4>
133       
134          <div class="comments">
135 A structure
136</div>
137           
138            <h4 id="_extractstru_param_liste">liste&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144              <span class="attr">type:</span> <span class="value">vector</span>
145             
146             
147            </h4>
148       
149          <div class="comments">
150 A vector of string including names of STRU to be deleted
151 (by default) or to be kept (if KEEP is activated).
152</div>
153           
154
155         
156
157         
158
159            <h3>Keywords</h3>
160           
161            <h4 id="_extractstru_keyword_KEEP">KEEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167             
168             
169             
170            </h4>
171       
172            <div class="comments">
173 Specify that the given liste concern elements of STRU to be kept.
174</div>
175           
176            <h4 id="_extractstru_keyword_DELETE">DELETE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
187            <div class="comments">
188 Specify  that the given liste concern elements of STRU to be deleted.
189
190 This keyword is activated by default.
191</div>
192           
193         
194
195          <h3>Examples</h3><div class="preformat">
196
197   IDL> extra=get_extra(/ok, year=1999, age_capitaine=35 )
198   IDL> help, extra,/struct
199    ** Structure <83e66bc>, 3 tags, length=6, refs=1:
200       AGE_CAPITAINE   INT             35
201       OK              INT              1
202       YEAR            INT           1999
203   IDL> help, extractstru(extra,['ok','hhuihi','YEAR']),/stru
204    ** Structure <831afac>, 1 tags, length=2, refs=1:
205       AGE_CAPITAINE   INT             35
206   IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/keep),/stru
207    ** Structure <834bbc4>, 2 tags, length=4, refs=1:
208       OK              INT              1
209       YEAR            INT           1999
210</div>
211          <h3>Version history</h3>
212         
213          <h4>Version</h4><div class="preformat">
214 $Id: extractstru.pro 375 2008-08-08 15:55:40Z pinsard $
215</div>
216          <h4>History</h4><div class="preformat">
217 Sebastien Masson (smasson@lodyc.jussieu.fr)
218                      8/10/1999
219</div>
220         
221         
222         
223         
224         
225         
226         
227       
228         
229         
230         
231         
232         
233         
234         
235       
236          <h3>Statistics</h3>
237          <table class="statistics">
238            <tr><td>McCabe cyclic</td><td>          12</td></tr>
239            <tr><td>McCabe essential</td><td>           1</td></tr>
240            <tr><td>McCabe modular design</td><td>           1</td></tr>
241          </table>
242         
243       
244        </div>
245       
246      </div>
247
248     
249
250      <div id="tagline">Produced by IDLdoc 2.0.</div>
251
252    </div>
253
254  </body>
255</html>
Note: See TracBrowser for help on using the repository browser.