| 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>find.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="find.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//find.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 documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 74 | <a href="demomode_compatibility.html"><<prev file</a> | <a href="fitintobox.html">next file >></a> <a href="find.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> |
|---|
| 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">find.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | based on <a href="/Applications/itt/idl64/help/online_help/FILE_SEARCH.html">FILE_SEARCH</a>, but it is possible to specify |
|---|
| 91 | a set of possibles names and a different set of |
|---|
| 92 | possibles directories names. |
|---|
| 93 | |
|---|
| 94 | By default look for files included in !path |
|---|
| 95 | |
|---|
| 96 | all <a href="/Applications/itt/idl64/help/online_help/FILE_SEARCH.html">FILE_SEARCH</a> keywords can be used. |
|---|
| 97 | </div> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | <div id="routine_details"> |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | <div class="routine_details" id="_find"> |
|---|
| 111 | |
|---|
| 112 | <h2><a class="top" href="#container">top</a>find <span class="categories"> |
|---|
| 113 | find a file |
|---|
| 114 | </span></h2> |
|---|
| 115 | |
|---|
| 116 | <p class="header"> |
|---|
| 117 | <span class="result">result = </span>find(<span class="result"><a href="#_find_param_filein">filein</a></span>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">scalar string or array of strings</span>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<span class="result">REPERTOIRE</span>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<span class="result">NOPRO</span>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<span class="result">UNIQUE</span>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<span class="result">FIRSTFOUND</span>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<span class="result">LOOKALLDIR</span>, <a href="#_find_keyword_TRYFIND">TRYFIND</a>=<span class="result">TRYFIND</span>, <a href="#_find_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
|---|
| 118 | |
|---|
| 119 | <div class="comments"> |
|---|
| 120 | </div> |
|---|
| 121 | |
|---|
| 122 | <h3>Return value</h3><div class="preformat"> |
|---|
| 123 | A scalar or array variable of string type, containing the |
|---|
| 124 | name (with the full path of the matching files. If no files |
|---|
| 125 | exist with names matching the input arguments, <a href="..//Utilities/find.html">find</a> returns |
|---|
| 126 | the scalar string : 'NOT FOUND' |
|---|
| 127 | </div> |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | <h3>Parameters</h3> |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | <h4 id="_find_param_filein">filein |
|---|
| 134 | <span class="attr">in</span> |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | <span class="attr">required</span> |
|---|
| 138 | |
|---|
| 139 | <span class="attr">type:</span> <span class="value">scalar string or array of strings</span> |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | </h4> |
|---|
| 143 | |
|---|
| 144 | <div class="comments"> |
|---|
| 145 | File name[s] to match. Input names specifications may contain |
|---|
| 146 | wildcard characters, enabling them to match multiple files |
|---|
| 147 | (see <a href="/Applications/itt/idl64/help/online_help/FILE_SEARCH.html">FILE_SEARCH</a> for more informations). By default and if |
|---|
| 148 | necessary, <a href="..//Utilities/find.html">find</a> is looking for filename and also for filename |
|---|
| 149 | completed with '.pro' |
|---|
| 150 | </div> |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | <h3>Keywords</h3> |
|---|
| 158 | |
|---|
| 159 | <h4 id="_find_keyword_IODIRECTORY">IODIRECTORY |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | <span class="attr">type:</span> <span class="value">scalar string or array of strings</span> |
|---|
| 166 | <span class="attr">default:</span> <span class="value">['.',!path]</span> |
|---|
| 167 | |
|---|
| 168 | </h4> |
|---|
| 169 | |
|---|
| 170 | <div class="comments"> |
|---|
| 171 | Directories names where we are looking for the file. |
|---|
| 172 | Different directories can be separated by |
|---|
| 173 | path_sep(/search_path) (':' on unix type machine) as it is done |
|---|
| 174 | to define !path. |
|---|
| 175 | Note that if filename's dirname is different from '.', this |
|---|
| 176 | keyword is not taken into account. |
|---|
| 177 | </div> |
|---|
| 178 | |
|---|
| 179 | <h4 id="_find_keyword_RECURSIVE">RECURSIVE |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | </h4> |
|---|
| 189 | |
|---|
| 190 | <div class="comments"> |
|---|
| 191 | performs recursive searching of directory hierarchies. |
|---|
| 192 | In a recursive search, <a href="..//Utilities/find.html">find</a> looks recursively for any and all |
|---|
| 193 | subdirectories in the file hierarchy rooted at the IODIRECTORY argument. |
|---|
| 194 | </div> |
|---|
| 195 | |
|---|
| 196 | <h4 id="_find_keyword_REPERTOIRE">REPERTOIRE |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | </h4> |
|---|
| 206 | |
|---|
| 207 | <div class="comments"> |
|---|
| 208 | obsolete. keep for compatibility, use IODIRECTORY keyword |
|---|
| 209 | </div> |
|---|
| 210 | |
|---|
| 211 | <h4 id="_find_keyword_NOPRO">NOPRO |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | </h4> |
|---|
| 221 | |
|---|
| 222 | <div class="comments"> |
|---|
| 223 | activate to avoid the automatic search of filename completed with '.pro' |
|---|
| 224 | </div> |
|---|
| 225 | |
|---|
| 226 | <h4 id="_find_keyword_ONLYPRO">ONLYPRO |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | </h4> |
|---|
| 236 | |
|---|
| 237 | <div class="comments"> |
|---|
| 238 | force to look only at file ending with .pro |
|---|
| 239 | </div> |
|---|
| 240 | |
|---|
| 241 | <h4 id="_find_keyword_ONLYNC">ONLYNC |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | </h4> |
|---|
| 251 | |
|---|
| 252 | <div class="comments"> |
|---|
| 253 | force to look only at file ending with .nc |
|---|
| 254 | </div> |
|---|
| 255 | |
|---|
| 256 | <h4 id="_find_keyword_UNIQUE">UNIQUE |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | </h4> |
|---|
| 266 | |
|---|
| 267 | <div class="comments"> |
|---|
| 268 | activate to make sure that each element of the output vector is unique. |
|---|
| 269 | </div> |
|---|
| 270 | |
|---|
| 271 | <h4 id="_find_keyword_FIRSTFOUND">FIRSTFOUND |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | </h4> |
|---|
| 281 | |
|---|
| 282 | <div class="comments"> |
|---|
| 283 | activate this keyword to stop looking for the file as soon as we |
|---|
| 284 | found one. Return a scalar string containing the first file found |
|---|
| 285 | </div> |
|---|
| 286 | |
|---|
| 287 | <h4 id="_find_keyword_LOOKALLDIR">LOOKALLDIR |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | </h4> |
|---|
| 297 | |
|---|
| 298 | <div class="comments"> |
|---|
| 299 | activate to look for the file (with a recursive search if needed) |
|---|
| 300 | in . iodir, homedir, !path + the DATA:TestsData directory if it exists. |
|---|
| 301 | </div> |
|---|
| 302 | |
|---|
| 303 | <h4 id="_find_keyword_TRYFIND">TRYFIND |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | </h4> |
|---|
| 313 | |
|---|
| 314 | <div class="comments"> |
|---|
| 315 | if the file was not found and this keyword is activated, <a href="..//Utilities/find.html">find</a> |
|---|
| 316 | will call |
|---|
| 317 | itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find |
|---|
| 318 | the file we are looking for. Note that if the file was found at the |
|---|
| 319 | first try this keyword as no effect (which is not the case with LOOKALLDIR) |
|---|
| 320 | </div> |
|---|
| 321 | |
|---|
| 322 | <h4 id="_find_keyword__EXTRA">_EXTRA |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | </h4> |
|---|
| 332 | |
|---|
| 333 | <div class="comments"> |
|---|
| 334 | Used to pass keywords |
|---|
| 335 | </div> |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | |
|---|
| 339 | <h3>Examples</h3><div class="preformat"> |
|---|
| 340 | |
|---|
| 341 | IDL> print, find('*loadct') |
|---|
| 342 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
|---|
| 343 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
|---|
| 344 | IDL> print, find('*loadct', iodir=!dir,/recursive) |
|---|
| 345 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
|---|
| 346 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
|---|
| 347 | IDL> print, find('*loadct.pro') |
|---|
| 348 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
|---|
| 349 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
|---|
| 350 | IDL> print, find('*loadct',/nopro) |
|---|
| 351 | NOT FOUND |
|---|
| 352 | IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib') |
|---|
| 353 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
|---|
| 354 | IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write) |
|---|
| 355 | NOT FOUND |
|---|
| 356 | IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive) |
|---|
| 357 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
|---|
| 358 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
|---|
| 359 | IDL> print, find('mesh*', iodirectory = [iodir, !path]) |
|---|
| 360 | /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc |
|---|
| 361 | /Users/sebastie/IDL/meshmaskclosesea.pro |
|---|
| 362 | /Users/sebastie/IDL/meshmaskclosesea.pro~ |
|---|
| 363 | /Users/sebastie/SAXO_RD/Obsolete/meshlec.pro |
|---|
| 364 | /usr/local/rsi/idl_6.0/lib/mesh_obj.pro |
|---|
| 365 | </div> |
|---|
| 366 | <h3>Version history</h3> |
|---|
| 367 | |
|---|
| 368 | <h4>Version</h4><div class="preformat"> |
|---|
| 369 | $Id: find.pro 375 2008-08-08 15:55:40Z pinsard $ |
|---|
| 370 | </div> |
|---|
| 371 | <h4>History</h4><div class="preformat"> |
|---|
| 372 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 373 | - 28/4/1999 |
|---|
| 374 | - 6/7/1999: compatibility mac and windows |
|---|
| 375 | - June 2005: Sebastien Masson: cleaning, use for file_* functions |
|---|
| 376 | </div> |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | |
|---|
| 382 | |
|---|
| 383 | |
|---|
| 384 | |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | <h3>Statistics</h3> |
|---|
| 394 | <table class="statistics"> |
|---|
| 395 | <tr><td>McCabe cyclic</td><td> 22</td></tr> |
|---|
| 396 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 397 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 398 | </table> |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | </div> |
|---|
| 402 | |
|---|
| 403 | </div> |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 408 | |
|---|
| 409 | </div> |
|---|
| 410 | |
|---|
| 411 | </body> |
|---|
| 412 | </html> |
|---|
