| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>strkeywd.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="string2struct.html"><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="strright.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">ToBeReviewed/STRING/</font></h1> |
|---|
| 58 | <h2>strkeywd.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | Translate a structure in a string able to be used to specify keywords |
|---|
| 65 | in the calling of a function when we use EXECUTE (see example) |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | |
|---|
| 71 | <a name="#_strkeywd"></a> |
|---|
| 72 | |
|---|
| 73 | <h2>strkeywd <font size="-1" color="#006633"> |
|---|
| 74 | </font></h2> |
|---|
| 75 | |
|---|
| 76 | <p><font face="Courier"><i>result = </i>strkeywd(<i><a href="#_strkeywd_keyword_struct">struct</a></i>)</font></p> |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | <h3>Return value</h3> |
|---|
| 82 | a string composed like following: |
|---|
| 83 | For each element of the structure, we write a part of the string as: |
|---|
| 84 | 'name_of_the_element=content_of_the_element' |
|---|
| 85 | |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | <h3>Parameters</h3> |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | <a name="#_strkeywd_keyword_struct"></a> |
|---|
| 92 | <h4>struct |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | </h4> |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | a structure |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | <h3>Examples</h3><pre> |
|---|
| 112 | |
|---|
| 113 | We create a structure: |
|---|
| 114 | IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35) |
|---|
| 115 | IDL> help, b,/struct |
|---|
| 116 | ** Structure <817f4bc>, 3 tags, length=10, refs=1: |
|---|
| 117 | AGE_CAPITAINE INT 35 |
|---|
| 118 | OK INT 111 |
|---|
| 119 | YEAR INT Array[3] |
|---|
| 120 | |
|---|
| 121 | We put this structure as a string: |
|---|
| 122 | IDL> a=strkeywd(b) |
|---|
| 123 | IDL> print, a |
|---|
| 124 | AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999] |
|---|
| 125 | |
|---|
| 126 | Now we can use the string a to pass keywords in a function thanks to execute!! |
|---|
| 127 | IDL> test=execute('c=get_extra('+a+')') |
|---|
| 128 | IDL> help, c,/struct |
|---|
| 129 | ** Structure <817f2dc>, 3 tags, length=10, refs=1: |
|---|
| 130 | AGE_CAPITAINE INT 35 |
|---|
| 131 | OK INT 111 |
|---|
| 132 | YEAR INT Array[3] |
|---|
| 133 | |
|---|
| 134 | </pre><h3>Version history</h3> |
|---|
| 135 | |
|---|
| 136 | <h4>Version</h4> |
|---|
| 137 | $Id: strkeywd.pro 372 2008-08-08 12:31:53Z pinsard $ |
|---|
| 138 | |
|---|
| 139 | <h4>History</h4> |
|---|
| 140 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 141 | 11/10/1999 |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | <h3>Known issues</h3> |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | <h4>Restrictions</h4> |
|---|
| 150 | If an element of the structure contain an array, it will be convert in a |
|---|
| 151 | vector. |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | Beware, this function has loops, ifs and cases everywhere. So it can |
|---|
| 155 | not be used by big keywords (with a lot of elements which are big |
|---|
| 156 | arrays). The input keyword must not contain Complex floatings, structure, |
|---|
| 157 | Double-precision complex, Pointer, Object reference, Unsigned Integer, |
|---|
| 158 | Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer. |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | <font size="-3"><p> </p></font> |
|---|
| 170 | <hr size="1" color="#CCCCCC"/> |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 176 | |
|---|
| 177 | </body> |
|---|
| 178 | </html> |
|---|
