source: trunk/SRC/Documentation/idldoc_html_output/Utilities/createfunc.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
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>createfunc.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="createfunc.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//createfunc.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&lt;&lt; prev file | <a href="createpro.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="createfunc.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">createfunc.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 write an IDL function, compile it and execute it.
91 useful to avoid the use of execute
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_createfunc">
106
107          <h2><a class="top" href="#container">top</a>createfunc </h2>
108       
109          <p class="header">
110            <span class="result">result = </span>createfunc(<span class="result"><a href="#_createfunc_param_command">command</a></span>, <a href="#_createfunc_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createfunc_keyword_KWDLIST">KWDLIST</a>=<span class="result">vector string</span>, <a href="#_createfunc_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
111       
112          <div class="comments">
113</div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_createfunc_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127              <span class="attr">type:</span> <span class="value">scalar string</span>
128             
129             
130            </h4>
131       
132          <div class="comments">
133 defining the result to be given back by the function.
134 (see examples)
135</div>
136           
137
138         
139
140         
141
142            <h3>Keywords</h3>
143           
144            <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145              <span class="attr">in</span>
146             
147             
148             
149             
150             
151              <span class="attr">default:</span> <span class="value">for_createfunc.pro</span>
152             
153            </h4>
154       
155            <div class="comments">
156 name of the function to be created.
157</div>
158           
159            <h4 id="_createfunc_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160              <span class="attr">in</span>
161             
162             
163             
164             
165              <span class="attr">type:</span> <span class="value">vector string</span>
166             
167             
168            </h4>
169       
170            <div class="comments"> 
171 to specify a list of keywords that must be included in the
172 function definition.
173 Warning: the string must start with a ','
174 for example: KWDLIST=', TOTO=toto'
175</div>
176           
177            <h4 id="_createfunc_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments"> 
189 Used to pass keywords to the created function.
190</div>
191           
192         
193
194          <h3>Examples</h3><div class="preformat">
195 IDL> print, createfunc('3*2', FILENAMEIN='test')
196 IDL> print, createfunc('3*two', FILENAMEIN='test' $
197 IDL>                          , KWDLIST='two = two', TWO=2)
198</div>
199          <h3>Version history</h3>
200         
201          <h4>Version</h4><div class="preformat">
202 $Id: createfunc.pro 327 2007-12-13 16:22:35Z pinsard $
203</div>
204          <h4>History</h4><div class="preformat">
205 Sebastien Masson (smasson@lodyc.jussieu.fr)
206                      May 2005
207</div>
208         
209         
210          <h3>Known issues</h3>
211         
212         
213         
214          <h4>Restrictions</h4><div class="preformat">
215 - arguments can be given only through keywords;
216 - ends the function name with '.pro' if needed.
217</div>
218       
219         
220         
221         
222         
223         
224         
225         
226       
227          <h3>Statistics</h3>
228          <table class="statistics">
229            <tr><td>McCabe cyclic</td><td>           8</td></tr>
230            <tr><td>McCabe essential</td><td>           1</td></tr>
231            <tr><td>McCabe modular design</td><td>           1</td></tr>
232          </table>
233         
234       
235        </div>
236       
237      </div>
238
239     
240
241      <div id="tagline">Produced by IDLdoc 2.0.</div>
242
243    </div>
244
245  </body>
246</html>
Note: See TracBrowser for help on using the repository browser.