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

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

update documentation
File size: 5.6 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>mixstru.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="mixstru.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//mixstru.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="extractstru.html">&lt;&lt;prev file</a> | <a href="struct2string.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="mixstru.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">mixstru.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Concatenate 2 structures together.
91
92 The difference with <a href="/Applications/itt/idl64/help/online_help/CREATE_STRUCT.html">CREATE_STRUCT</a>
93 is that if the 2 structures have same elements's name, then mixstru
94 do not break down but choose for the common element the value
95 specified by the first structure.
96</div>
97
98     
99
100     
101
102     
103
104     
105
106      <div id="routine_details">
107       
108
109        <div class="routine_details" id="_mixstru">
110
111          <h2><a class="top" href="#container">top</a>mixstru <span class="categories">
112 Structure
113 </span></h2>
114       
115          <p class="header">
116            <span class="result">result = </span>mixstru(<span class="result"><a href="#_mixstru_param_stru1">stru1</a>, <a href="#_mixstru_param_stru2">stru2</a></span>)</p>
117       
118          <div class="comments">
119</div>
120
121          <h3>Return value</h3><div class="preformat">
122 A structure
123</div>
124
125         
126            <h3>Parameters</h3>
127       
128           
129            <h4 id="_mixstru_param_stru1">stru1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130              <span class="attr">in</span>
131             
132             
133              <span class="attr">required</span>
134             
135             
136             
137             
138            </h4>
139       
140          <div class="comments">
141 Structure which can have same elements's name than
142 STRU2 but with a different value.
143</div>
144           
145            <h4 id="_mixstru_param_stru2">stru2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146              <span class="attr">in</span>
147             
148             
149              <span class="attr">required</span>
150             
151             
152             
153             
154            </h4>
155       
156          <div class="comments">
157 Structure which can have same elements's name than
158 STRU1 but with a different value.
159</div>
160           
161
162         
163
164         
165
166          <h3>Examples</h3><div class="preformat">
167     
168   IDL> a=get_extra(/toto,ok=123)
169   IDL> b=get_extra(ok=111, year=1999, age_capitaine=35)
170   IDL> help, a,b,/struct
171     ** Structure <8334424>, 2 tags, length=4, refs=1:
172        OK              INT            123
173        TOTO            INT              1
174     ** Structure <8373da4>, 3 tags, length=6, refs=1:
175        AGE_CAPITAINE   INT             35
176        OK              INT            111
177        YEAR            INT           1999
178   IDL> help, mixstru(a,b),/struct
179     ** Structure <82f25ac>, 4 tags, length=8, refs=1:
180        AGE_CAPITAINE   INT             35
181        YEAR            INT           1999
182        OK              INT            123
183        TOTO            INT              1
184   IDL> help, mixstru(b,a),/struct
185     ** Structure <834604c>, 4 tags, length=8, refs=1:
186        TOTO            INT              1
187        AGE_CAPITAINE   INT             35
188        OK              INT            111
189        YEAR            INT           1999
190</div>
191          <h3>Version history</h3>
192         
193          <h4>Version</h4><div class="preformat">
194 $Id: mixstru.pro 375 2008-08-08 15:55:40Z pinsard $
195</div>
196          <h4>History</h4><div class="preformat">
197 Sebastien Masson (smasson@lodyc.jussieu.fr)
198                      7/10/1999
199</div>
200         
201         
202          <h3>Known issues</h3>
203         
204         
205         
206          <h4>Restrictions</h4><div class="preformat">
207 If STRU1 or STRU2 are not structure, mixstru send back -1
208</div>
209       
210         
211         
212         
213         
214         
215         
216         
217       
218          <h3>Statistics</h3>
219          <table class="statistics">
220            <tr><td>McCabe cyclic</td><td>           6</td></tr>
221            <tr><td>McCabe essential</td><td>           1</td></tr>
222            <tr><td>McCabe modular design</td><td>           1</td></tr>
223          </table>
224         
225       
226        </div>
227       
228      </div>
229
230     
231
232      <div id="tagline">Produced by IDLdoc 2.0.</div>
233
234    </div>
235
236  </body>
237</html>
Note: See TracBrowser for help on using the repository browser.