1 | |
---|
2 | |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
4 | <head> |
---|
5 | <title>createfunc.pro (SAXO Documentation Assistant)</title> |
---|
6 | </head> |
---|
7 | |
---|
8 | <body text="#000000" bgcolor="#FFFFFF"> |
---|
9 | |
---|
10 | |
---|
11 | <!-- Navbar template takes a structure with the following fields: |
---|
12 | overview_href : |
---|
13 | overview_selected : |
---|
14 | dir_overview_href : |
---|
15 | dir_overview_selected : |
---|
16 | categories_href : |
---|
17 | categories_selected : |
---|
18 | index_href : |
---|
19 | index_selected : |
---|
20 | search_href : |
---|
21 | search_selected : |
---|
22 | file_selected : |
---|
23 | source_href : |
---|
24 | source_selected : |
---|
25 | help_href : |
---|
26 | help_selected : |
---|
27 | etc_selected : |
---|
28 | |
---|
29 | prev_file_href : |
---|
30 | next_file_href : |
---|
31 | |
---|
32 | view_single_page_href : |
---|
33 | view_frames_href : |
---|
34 | |
---|
35 | summary_fields_href : |
---|
36 | summary_routine_href : |
---|
37 | details_routine_href : |
---|
38 | |
---|
39 | title : |
---|
40 | subtitle : |
---|
41 | user : |
---|
42 | --> |
---|
43 | |
---|
44 | |
---|
45 | <table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom"> |
---|
46 | <tr> |
---|
47 | <td width="10%"> |
---|
48 | <a href=""><img src="./../prev.gif" border="0" alt="Previous"></a></td> |
---|
49 | <td width="80%" align="center" valign="center"> |
---|
50 | <font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> |
---|
51 | <td width="10%" align="right"> |
---|
52 | <a href="createpro.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
---|
53 | </tr> |
---|
54 | </table> |
---|
55 | |
---|
56 | |
---|
57 | <h1><font size="-2">Utilities/</font></h1> |
---|
58 | <h2>createfunc.pro</h2> |
---|
59 | |
---|
60 | <dl> |
---|
61 | </dl> |
---|
62 | |
---|
63 | |
---|
64 | write an IDL function, compile it and execute it. |
---|
65 | useful to avoid the use of execute |
---|
66 | |
---|
67 | |
---|
68 | |
---|
69 | |
---|
70 | |
---|
71 | <a name="#_createfunc"></a> |
---|
72 | |
---|
73 | <h2>createfunc </h2> |
---|
74 | |
---|
75 | <p><font face="Courier"><i>result = </i>createfunc(<i><a href="#_createfunc_keyword_command">command</a></i>, <a href="#_createfunc_keyword_FILENAMEIN">FILENAMEIN</a>=<i>FILENAMEIN</i>, <a href="#_createfunc_keyword_KWDLIST">KWDLIST</a>=<i>vector string</i>, <a href="#_createfunc_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> |
---|
76 | |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | |
---|
81 | |
---|
82 | |
---|
83 | <h3>Parameters</h3> |
---|
84 | |
---|
85 | |
---|
86 | <a name="#_createfunc_keyword_command"></a> |
---|
87 | <h4>command |
---|
88 | <font size="-1" color="#006633">in</font> |
---|
89 | |
---|
90 | |
---|
91 | <font size="-1" color="#006633">required</font> |
---|
92 | |
---|
93 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
---|
94 | |
---|
95 | |
---|
96 | </h4> |
---|
97 | |
---|
98 | |
---|
99 | defining the result to be given back by the function. |
---|
100 | (see examples) |
---|
101 | |
---|
102 | |
---|
103 | |
---|
104 | |
---|
105 | |
---|
106 | <h3>Keywords</h3> |
---|
107 | |
---|
108 | |
---|
109 | <a name="#_createfunc_keyword_FILENAMEIN"></a> |
---|
110 | <h4>FILENAMEIN |
---|
111 | <font size="-1" color="#006633">in</font> |
---|
112 | |
---|
113 | |
---|
114 | |
---|
115 | |
---|
116 | |
---|
117 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>for_createfunc.pro</i></font> |
---|
118 | |
---|
119 | </h4> |
---|
120 | |
---|
121 | |
---|
122 | name of the function to be created. |
---|
123 | |
---|
124 | |
---|
125 | <a name="#_createfunc_keyword_KWDLIST"></a> |
---|
126 | <h4>KWDLIST |
---|
127 | <font size="-1" color="#006633">in</font> |
---|
128 | |
---|
129 | |
---|
130 | |
---|
131 | |
---|
132 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector string</i></font> |
---|
133 | |
---|
134 | |
---|
135 | </h4> |
---|
136 | |
---|
137 | |
---|
138 | to specify a list of keywords that must be included in the |
---|
139 | function definition. |
---|
140 | |
---|
141 | Warning: the string must start with a ',' |
---|
142 | for example: KWDLIST=', TOTO=toto' |
---|
143 | |
---|
144 | |
---|
145 | <a name="#_createfunc_keyword__EXTRA"></a> |
---|
146 | <h4>_EXTRA |
---|
147 | |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | </h4> |
---|
156 | |
---|
157 | |
---|
158 | Used to pass keywords to the created function. |
---|
159 | |
---|
160 | |
---|
161 | |
---|
162 | |
---|
163 | <h3>Examples</h3><pre> |
---|
164 | |
---|
165 | IDL> print, createfunc('3*2', FILENAMEIN='test') |
---|
166 | IDL> print, createfunc('3*two', FILENAMEIN='test' $ |
---|
167 | IDL> , KWDLIST='two = two', TWO=2) |
---|
168 | |
---|
169 | </pre><h3>Version history</h3> |
---|
170 | |
---|
171 | <h4>Version</h4> |
---|
172 | $Id: createfunc.pro 375 2008-08-08 15:55:40Z pinsard $ |
---|
173 | |
---|
174 | <h4>History</h4> |
---|
175 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
176 | May 2005 |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | <h3>Known issues</h3> |
---|
181 | |
---|
182 | |
---|
183 | |
---|
184 | <h4>Restrictions</h4> |
---|
185 | - arguments can be given only through keywords; |
---|
186 | - ends the function name with '.pro' if needed. |
---|
187 | |
---|
188 | |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | |
---|
194 | |
---|
195 | |
---|
196 | |
---|
197 | <font size="-3"><p> </p></font> |
---|
198 | <hr size="1" color="#CCCCCC"/> |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
204 | |
---|
205 | </body> |
---|
206 | </html> |
---|