source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/struct2string.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 5.5 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>struct2string.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="struct2string.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//struct2string.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="mixstru.html">&lt;&lt;prev file</a> | <a href="where_tag.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="struct2string.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">struct2string.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Convert a structure to an "executable string"
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_struct2string">
105
106          <h2><a class="top" href="#container">top</a>struct2string <span class="categories">
107 Utilities
108 </span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>struct2string(<span class="result"><a href="#_struct2string_param_struct">struct</a></span>, <a href="#_struct2string_keyword_CUT_IN_STRING">CUT_IN_STRING</a>=<span class="result">CUT_IN_STRING</span>, <a href="#_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH</a>=<span class="result">MAX_STRUCT_LENGTH</span>, <a href="#_struct2string_keyword_DIRECT2STRING">DIRECT2STRING</a>=<span class="result">DIRECT2STRING</span>)</p>
112       
113          <div class="comments">
114 </div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_struct2string_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments">
134 A structure
135</div>
136           
137
138         
139
140         
141
142            <h3>Keywords</h3>
143           
144            <h4 id="_struct2string_keyword_CUT_IN_STRING">CUT_IN_STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145             
146             
147             
148             
149             
150             
151             
152             
153            </h4>
154       
155            <div class="comments">
156 Try it
157</div>
158           
159            <h4 id="_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160             
161             
162             
163             
164             
165             
166              <span class="attr">default:</span> <span class="value">10000l</span>
167             
168            </h4>
169       
170            <div class="comments">
171 The maximum length of the structure
172 permetted to convert the structure to string.
173</div>
174           
175            <h4 id="_struct2string_keyword_DIRECT2STRING">DIRECT2STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176             
177             
178             
179             
180             
181             
182             
183             
184            </h4>
185       
186            <div class="comments">
187 To get a string instead an "executable string"
188</div>
189           
190         
191
192          <h3>Examples</h3><div class="preformat">
193
194      IDL> print, struct2string(!d)
195      create_struct('NAME','X','X_SIZE',891,'Y_SIZE',630,'X_VSIZE'
196      ,891,'Y_VSIZE',630,'X_CH_SIZE',6,'Y_CH_SIZE',10,'X_PX_CM'
197      ,40.0000,'Y_PX_CM',40.0000,'N_COLORS',16777216,'TABLE_SIZE'
198      ,256,'FILL_DIST',1,'WINDOW',32,'UNIT',0,'FLAGS',328124,'ORIGIN'
199      ,[0,0],'ZOOM',[1,1])
200</div>
201          <h3>Version history</h3>
202         
203          <h4>Version</h4><div class="preformat">
204 $Id: struct2string.pro 163 2006-08-29 12:59:46Z navarro $
205</div>
206          <h4>History</h4><div class="preformat">
207 Sebastien Masson (smasson@lodyc.jussieu.fr)
208                      2000 07 03
209</div>
210         
211         
212          <h3>Known issues</h3>
213         
214         
215         
216          <h4>Restrictions</h4><div class="preformat">
217 Use tostr.pro, cf this function header!
218</div>
219       
220         
221         
222         
223         
224         
225         
226         
227       
228          <h3>Statistics</h3>
229          <table class="statistics">
230            <tr><td>McCabe cyclic</td><td>          13</td></tr>
231            <tr><td>McCabe essential</td><td>           1</td></tr>
232            <tr><td>McCabe modular design</td><td>           1</td></tr>
233          </table>
234         
235       
236        </div>
237       
238      </div>
239
240     
241
242      <div id="tagline">Produced by IDLdoc 2.0.</div>
243
244    </div>
245
246  </body>
247</html>
Note: See TracBrowser for help on using the repository browser.