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

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