source: trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html

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

update documentation
File size: 6.2 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>createpro.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="createpro.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="../../../Utilities//createpro.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="createfunc.html">&lt;&lt;prev file</a> | <a href="def_myuniquetmpdir.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="createpro.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">Utilities/</a></h1>
82      <h2 class="pro_file">createpro.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 write an idl procedure, compile it and execute it.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_createpro">
105
106          <h2><a class="top" href="#container">top</a>createpro </h2>
107       
108          <p class="header">
109            createpro<span class="result">, <a href="#_createpro_param_command">command</a></span>, <a href="#_createpro_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createpro_keyword_KWDLIST">KWDLIST</a>=<span class="result">vector string</span>, <a href="#_createpro_keyword_KWDUSED">KWDUSED</a>=<span class="result">KWDUSED</span>, <a href="#_createpro_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
110       
111          <div class="comments">
112</div>
113
114         
115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_createpro_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121              <span class="attr">in</span>
122             
123             
124              <span class="attr">required</span>
125             
126              <span class="attr">type:</span> <span class="value">string array</span>
127             
128             
129            </h4>
130       
131          <div class="comments">
132 array defining the procedure to be created.
133 each element will be a line of the created procedure.
134</div>
135           
136
137         
138
139         
140
141            <h3>Keywords</h3>
142           
143            <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144              <span class="attr">in</span>
145             
146             
147             
148             
149             
150              <span class="attr">default:</span> <span class="value">for_createpro.pro</span>
151             
152            </h4>
153       
154            <div class="comments">
155 name of the procedure to be created.
156</div>
157           
158            <h4 id="_createpro_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159              <span class="attr">in</span>
160             
161             
162             
163             
164              <span class="attr">type:</span> <span class="value">vector string</span>
165             
166             
167            </h4>
168       
169            <div class="comments">
170 to specify a list of keywords that must be included in the procedure
171 definition.
172
173 Warning: the string must start with a ','
174 for example: KWDLIST=', TOTO = toto'
175</div>
176           
177            <h4 id="_createpro_keyword_KWDUSED">KWDUSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments"> 
189 obsolete, please pass directly your keywords through _EXTRA
190</div>
191           
192            <h4 id="_createpro_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193             
194             
195             
196             
197             
198             
199             
200             
201            </h4>
202       
203            <div class="comments"> 
204 Used to pass keywords to the created procedure.
205</div>
206           
207         
208
209          <h3>Examples</h3><div class="preformat">
210
211   IDL> createpro, ['print,''OK'''], FILENAMEIN='test'
212   IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
213   IDL>   , FILENAMEIN='test', KWDLIST =', ok = ok'
214   IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
215   IDL>   , FILENAMEIN='test', KWDLIST= ', ok = ok', /ok
216</div>
217          <h3>Version history</h3>
218         
219          <h4>Version</h4><div class="preformat">
220 $Id: createpro.pro 375 2008-08-08 15:55:40Z pinsard $
221</div>
222          <h4>History</h4><div class="preformat">
223 Sebastien Masson (smasson@lodyc.jussieu.fr)
224  - cleaning + new keywords: October 2005
225  - Feb. 2006: supress keyword "kwdused" and use call_procedure instead of
226    execute
227</div>
228         
229         
230          <h3>Known issues</h3>
231         
232         
233         
234          <h4>Restrictions</h4><div class="preformat">
235 - is not working with functions, use <a href="..//Utilities/createfunc.html">createfunc</a> instead.
236 - arguments can be given only through keywords.
237 - ends the procedure name with '.pro' if needed.
238</div>
239       
240         
241         
242         
243         
244         
245         
246         
247       
248          <h3>Statistics</h3>
249          <table class="statistics">
250            <tr><td>McCabe cyclic</td><td>           8</td></tr>
251            <tr><td>McCabe essential</td><td>           1</td></tr>
252            <tr><td>McCabe modular design</td><td>           1</td></tr>
253          </table>
254         
255       
256        </div>
257       
258      </div>
259
260     
261
262      <div id="tagline">Produced by IDLdoc 2.0.</div>
263
264    </div>
265
266  </body>
267</html>
Note: See TracBrowser for help on using the repository browser.