[89] | 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> |
---|
[104] | 9 | <title>createpro.pro (SAXO Documentation)</title> |
---|
[89] | 10 | |
---|
| 11 | |
---|
[191] | 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" /> |
---|
[89] | 14 | |
---|
| 15 | |
---|
| 16 | <script type="text/javascript"> |
---|
| 17 | function setTitle() { |
---|
[104] | 18 | parent.document.title="createpro.pro (SAXO Documentation)"; |
---|
[89] | 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
[104] | 26 | <h1>SAXO Documentation</h1> |
---|
[89] | 27 | </div> |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | <div id="main_navbar"> |
---|
| 31 | |
---|
| 32 | <table cellspacing="0"> |
---|
| 33 | <tr> |
---|
| 34 | |
---|
[189] | 35 | <td><a href="./../overview.html" title="Overview of library">Overview</a></td> |
---|
[89] | 36 | |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | <td >Directory</td> |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | |
---|
[189] | 43 | <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
---|
[89] | 44 | |
---|
| 45 | |
---|
| 46 | |
---|
[189] | 47 | <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
---|
[89] | 48 | |
---|
| 49 | |
---|
| 50 | |
---|
[189] | 51 | <td><a href="./../search-page.html" title="Search library">Search</a></td> |
---|
[89] | 52 | |
---|
| 53 | |
---|
| 54 | <td id="selected">File</td> |
---|
| 55 | |
---|
| 56 | |
---|
[189] | 57 | <td><a href="../../../Utilities//createpro.pro" title="Source code of a file">Source</a></td> |
---|
[89] | 58 | |
---|
| 59 | |
---|
| 60 | |
---|
[189] | 61 | <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td> |
---|
[89] | 62 | |
---|
| 63 | |
---|
| 64 | <td >Etc</td> |
---|
| 65 | |
---|
| 66 | <td id="flexible">Developer documentation</td> |
---|
| 67 | </tr> |
---|
| 68 | </table> |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div id="secondary_navbar"> |
---|
| 73 | |
---|
[189] | 74 | <a href="createfunc.html"><<prev file</a> | <a href="def_myuniquetmpdir.html">next file >></a> <a href="createpro.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a> |
---|
[89] | 75 | |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | <div id="container"> |
---|
| 80 | |
---|
[189] | 81 | <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1> |
---|
[89] | 82 | <h2 class="pro_file">createpro.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[138] | 89 | <div id="file_comments"> |
---|
| 90 | write an idl procedure, compile it and execute it. |
---|
[97] | 91 | </div> |
---|
[89] | 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"> |
---|
[242] | 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> |
---|
[89] | 110 | |
---|
[234] | 111 | <div class="comments"> |
---|
| 112 | </div> |
---|
[89] | 113 | |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | <h3>Parameters</h3> |
---|
| 118 | |
---|
| 119 | |
---|
| 120 | <h4 id="_createpro_param_command">command |
---|
[93] | 121 | <span class="attr">in</span> |
---|
[89] | 122 | |
---|
| 123 | |
---|
[93] | 124 | <span class="attr">required</span> |
---|
[89] | 125 | |
---|
[163] | 126 | <span class="attr">type:</span> <span class="value">string array</span> |
---|
[89] | 127 | |
---|
| 128 | |
---|
| 129 | </h4> |
---|
| 130 | |
---|
[163] | 131 | <div class="comments"> |
---|
[242] | 132 | array defining the procedure to be created. |
---|
[138] | 133 | each element will be a line of the created procedure. |
---|
[93] | 134 | </div> |
---|
[89] | 135 | |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | <h3>Keywords</h3> |
---|
| 142 | |
---|
| 143 | <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN |
---|
[118] | 144 | <span class="attr">in</span> |
---|
[89] | 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
[121] | 150 | <span class="attr">default:</span> <span class="value">for_createpro.pro</span> |
---|
[89] | 151 | |
---|
| 152 | </h4> |
---|
| 153 | |
---|
[121] | 154 | <div class="comments"> |
---|
[138] | 155 | name of the procedure to be created. |
---|
[93] | 156 | </div> |
---|
[89] | 157 | |
---|
| 158 | <h4 id="_createpro_keyword_KWDLIST">KWDLIST |
---|
[118] | 159 | <span class="attr">in</span> |
---|
[89] | 160 | |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | |
---|
[242] | 164 | <span class="attr">type:</span> <span class="value">vector string</span> |
---|
[89] | 165 | |
---|
| 166 | |
---|
| 167 | </h4> |
---|
| 168 | |
---|
[242] | 169 | <div class="comments"> |
---|
[138] | 170 | to specify a list of keywords that must be included in the procedure |
---|
| 171 | definition. |
---|
[402] | 172 | |
---|
[138] | 173 | Warning: the string must start with a ',' |
---|
[338] | 174 | for example: KWDLIST=', TOTO = toto' |
---|
[93] | 175 | </div> |
---|
[89] | 176 | |
---|
| 177 | <h4 id="_createpro_keyword_KWDUSED">KWDUSED |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | </h4> |
---|
| 187 | |
---|
[138] | 188 | <div class="comments"> |
---|
| 189 | obsolete, please pass directly your keywords through _EXTRA |
---|
[118] | 190 | </div> |
---|
[89] | 191 | |
---|
[121] | 192 | <h4 id="_createpro_keyword__EXTRA">_EXTRA |
---|
[89] | 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | |
---|
| 201 | </h4> |
---|
| 202 | |
---|
[138] | 203 | <div class="comments"> |
---|
[234] | 204 | Used to pass keywords to the created procedure. |
---|
[93] | 205 | </div> |
---|
[89] | 206 | |
---|
| 207 | |
---|
| 208 | |
---|
[138] | 209 | <h3>Examples</h3><div class="preformat"> |
---|
[402] | 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 |
---|
[93] | 216 | </div> |
---|
| 217 | <h3>Version history</h3> |
---|
[89] | 218 | |
---|
[234] | 219 | <h4>Version</h4><div class="preformat"> |
---|
[402] | 220 | $Id: createpro.pro 375 2008-08-08 15:55:40Z pinsard $ |
---|
[242] | 221 | </div> |
---|
[234] | 222 | <h4>History</h4><div class="preformat"> |
---|
| 223 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
[402] | 224 | - cleaning + new keywords: October 2005 |
---|
| 225 | - Feb. 2006: supress keyword "kwdused" and use call_procedure instead of |
---|
| 226 | execute |
---|
[118] | 227 | </div> |
---|
[89] | 228 | |
---|
| 229 | |
---|
[93] | 230 | <h3>Known issues</h3> |
---|
[89] | 231 | |
---|
| 232 | |
---|
| 233 | |
---|
[138] | 234 | <h4>Restrictions</h4><div class="preformat"> |
---|
[290] | 235 | - is not working with functions, use <a href="..//Utilities/createfunc.html">createfunc</a> instead. |
---|
[118] | 236 | - arguments can be given only through keywords. |
---|
| 237 | - ends the procedure name with '.pro' if needed. |
---|
[93] | 238 | </div> |
---|
[89] | 239 | |
---|
| 240 | |
---|
| 241 | |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | |
---|
| 247 | |
---|
[163] | 248 | <h3>Statistics</h3> |
---|
| 249 | <table class="statistics"> |
---|
[242] | 250 | <tr><td>McCabe cyclic</td><td> 8</td></tr> |
---|
[163] | 251 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 252 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 253 | </table> |
---|
[89] | 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> |
---|
[249] | 267 | </html> |
---|