[163] | 1 | |
---|
| 2 | |
---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 4 | <head> |
---|
| 5 | <title>struct2string.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="mixstru.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="where_tag.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> |
---|
| 53 | </tr> |
---|
| 54 | </table> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | <h1><font size="-2">ToBeReviewed/STRUCTURE/</font></h1> |
---|
| 58 | <h2>struct2string.pro</h2> |
---|
| 59 | |
---|
| 60 | <dl> |
---|
| 61 | </dl> |
---|
| 62 | |
---|
| 63 | |
---|
| 64 | Convert a structure to an "executable string" |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | <a name="#_struct2string"></a> |
---|
| 71 | |
---|
| 72 | <h2>struct2string <font size="-1" color="#006633"> |
---|
| 73 | Utilities |
---|
| 74 | </font></h2> |
---|
| 75 | |
---|
| 76 | <p><font face="Courier"><i>result = </i>struct2string(<i><a href="#_struct2string_keyword_struct">struct</a></i>, <a href="#_struct2string_keyword_CUT_IN_STRING">CUT_IN_STRING</a>=<i>CUT_IN_STRING</i>, <a href="#_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH</a>=<i>MAX_STRUCT_LENGTH</i>, <a href="#_struct2string_keyword_DIRECT2STRING">DIRECT2STRING</a>=<i>DIRECT2STRING</i>)</font></p> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | |
---|
| 80 | |
---|
| 81 | |
---|
| 82 | |
---|
| 83 | |
---|
| 84 | <h3>Parameters</h3> |
---|
| 85 | |
---|
| 86 | |
---|
| 87 | <a name="#_struct2string_keyword_struct"></a> |
---|
| 88 | <h4>struct |
---|
| 89 | <font size="-1" color="#006633">in</font> |
---|
| 90 | |
---|
| 91 | |
---|
| 92 | <font size="-1" color="#006633">required</font> |
---|
| 93 | |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | </h4> |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | A structure |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | |
---|
| 105 | |
---|
| 106 | <h3>Keywords</h3> |
---|
| 107 | |
---|
| 108 | |
---|
| 109 | <a name="#_struct2string_keyword_CUT_IN_STRING"></a> |
---|
| 110 | <h4>CUT_IN_STRING |
---|
| 111 | |
---|
| 112 | |
---|
| 113 | |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | </h4> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | Try it |
---|
| 123 | |
---|
| 124 | |
---|
| 125 | <a name="#_struct2string_keyword_MAX_STRUCT_LENGTH"></a> |
---|
| 126 | <h4>MAX_STRUCT_LENGTH |
---|
| 127 | |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>10000l</i></font> |
---|
| 134 | |
---|
| 135 | </h4> |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | The maximum length of the structure |
---|
| 139 | permetted to convert the structure to string. |
---|
| 140 | |
---|
| 141 | |
---|
| 142 | <a name="#_struct2string_keyword_DIRECT2STRING"></a> |
---|
| 143 | <h4>DIRECT2STRING |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | </h4> |
---|
| 153 | |
---|
| 154 | |
---|
| 155 | To get a string instead an "executable string" |
---|
| 156 | |
---|
| 157 | |
---|
| 158 | |
---|
| 159 | |
---|
| 160 | <h3>Examples</h3> |
---|
| 161 | |
---|
| 162 | IDL> print, struct2string(!d) |
---|
| 163 | create_struct('NAME','X','X_SIZE',891,'Y_SIZE',630,'X_VSIZE' |
---|
| 164 | ,891,'Y_VSIZE',630,'X_CH_SIZE',6,'Y_CH_SIZE',10,'X_PX_CM' |
---|
| 165 | ,40.0000,'Y_PX_CM',40.0000,'N_COLORS',16777216,'TABLE_SIZE' |
---|
| 166 | ,256,'FILL_DIST',1,'WINDOW',32,'UNIT',0,'FLAGS',328124,'ORIGIN' |
---|
| 167 | ,[0,0],'ZOOM',[1,1]) |
---|
| 168 | |
---|
| 169 | <h3>Version history</h3> |
---|
| 170 | |
---|
| 171 | <h4>Version</h4> |
---|
| 172 | $Id: struct2string.pro 157 2006-08-21 09:01:50Z navarro $ |
---|
| 173 | |
---|
| 174 | <h4>History</h4> |
---|
| 175 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 176 | 2000 07 03 |
---|
| 177 | |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | <h3>Known issues</h3> |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | <h4>Restrictions</h4> |
---|
| 185 | Use tostr.pro, cf this function header! |
---|
| 186 | |
---|
| 187 | |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | <font size="-3"><p> </p></font> |
---|
| 197 | <hr size="1" color="#CCCCCC"/> |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0 on Tue Aug 29 14:50:33 2006.</font></p> |
---|
| 203 | |
---|
| 204 | </body> |
---|
| 205 | </html> |
---|