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>chkeywd.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="chkeywd.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="../../../../ToBeReviewed/STRING//chkeywd.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 | << prev file | <a href="delchr.html">next file >></a> <a href="chkeywd.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">ToBeReviewed/STRING/</a></h1> |
---|
82 | <h2 class="pro_file">chkeywd.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"> |
---|
90 | In a string containing an order to execute with EXECUTE by example. |
---|
91 | We change the value of one of keywords. |
---|
92 | |
---|
93 | More generally, in a string, we look for the character |
---|
94 | chain: ', keywdname= ..., and we change the value of... |
---|
95 | </div> |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | |
---|
102 | |
---|
103 | |
---|
104 | |
---|
105 | <div id="routine_details"> |
---|
106 | |
---|
107 | |
---|
108 | <div class="routine_details" id="_chkeywd"> |
---|
109 | |
---|
110 | <h2><a class="top" href="#container">top</a>chkeywd <span class="categories"> |
---|
111 | String, keywords |
---|
112 | </span></h2> |
---|
113 | |
---|
114 | <p class="header"> |
---|
115 | <span class="result">result = </span>chkeywd(<span class="result"><a href="#_chkeywd_param_stringin">stringin</a>, <a href="#_chkeywd_param_keywdname">keywdname</a>, <a href="#_chkeywd_param_keywdvalue">keywdvalue</a></span>, <a href="#_chkeywd_keyword_SEPARATOR">SEPARATOR</a>=<span class="result">SEPARATOR</span>, <a href="#_chkeywd_keyword_AFTER">AFTER</a>=<span class="result">AFTER</span>)</p> |
---|
116 | |
---|
117 | <div class="comments"> |
---|
118 | </div> |
---|
119 | |
---|
120 | <h3>Return value</h3><div class="preformat"> |
---|
121 | stringout=stringin modified if keywdname has been found in stringin |
---|
122 | </div> |
---|
123 | |
---|
124 | |
---|
125 | <h3>Parameters</h3> |
---|
126 | |
---|
127 | |
---|
128 | <h4 id="_chkeywd_param_stringin">stringin |
---|
129 | <span class="attr">in</span> |
---|
130 | |
---|
131 | |
---|
132 | <span class="attr">required</span> |
---|
133 | |
---|
134 | <span class="attr">type:</span> <span class="value">string</span> |
---|
135 | |
---|
136 | |
---|
137 | </h4> |
---|
138 | |
---|
139 | <div class="comments"> |
---|
140 | it is a string |
---|
141 | </div> |
---|
142 | |
---|
143 | <h4 id="_chkeywd_param_keywdname">keywdname |
---|
144 | <span class="attr">in</span> |
---|
145 | |
---|
146 | |
---|
147 | <span class="attr">required</span> |
---|
148 | |
---|
149 | <span class="attr">type:</span> <span class="value">string</span> |
---|
150 | |
---|
151 | |
---|
152 | </h4> |
---|
153 | |
---|
154 | <div class="comments"> |
---|
155 | it is a string designating the name of keyword to look for. |
---|
156 | </div> |
---|
157 | |
---|
158 | <h4 id="_chkeywd_param_keywdvalue">keywdvalue |
---|
159 | <span class="attr">in</span> |
---|
160 | |
---|
161 | |
---|
162 | <span class="attr">required</span> |
---|
163 | |
---|
164 | |
---|
165 | |
---|
166 | |
---|
167 | </h4> |
---|
168 | |
---|
169 | <div class="comments"> |
---|
170 | The new value of the keyword to considerate in STRINGIN |
---|
171 | </div> |
---|
172 | |
---|
173 | |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | <h3>Keywords</h3> |
---|
179 | |
---|
180 | <h4 id="_chkeywd_keyword_SEPARATOR">SEPARATOR |
---|
181 | |
---|
182 | |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | |
---|
187 | |
---|
188 | |
---|
189 | </h4> |
---|
190 | |
---|
191 | <div class="comments"> |
---|
192 | To look for the keyword, we look for the first sign = which follow |
---|
193 | the position of keywdname. By default, we substitute the string |
---|
194 | before the comma. With the keyword SEPARATOR,we can modify the cut |
---|
195 | of the string. SEPARATOR give a Character before the one we have to |
---|
196 | look for the comma which delimit the keyword in the string. |
---|
197 | (see examples) |
---|
198 | </div> |
---|
199 | |
---|
200 | <h4 id="_chkeywd_keyword_AFTER">AFTER |
---|
201 | |
---|
202 | |
---|
203 | |
---|
204 | |
---|
205 | |
---|
206 | |
---|
207 | |
---|
208 | |
---|
209 | </h4> |
---|
210 | |
---|
211 | <div class="comments"> |
---|
212 | To look for the keyword, we look for the first sign = which follow |
---|
213 | the position of keywdname. By default, we substitute the string |
---|
214 | before the comma. With the keyword AFTER,we can modify the cut |
---|
215 | of the string. AFTER give a Character after the one we have to |
---|
216 | look for the comma which delimit the keyword in the string. |
---|
217 | (see examples) |
---|
218 | </div> |
---|
219 | |
---|
220 | |
---|
221 | |
---|
222 | <h3>Examples</h3><div class="preformat"> |
---|
223 | |
---|
224 | IDL> b='ok=111, year=[1997,1998,1999], age_capitaine=35' |
---|
225 | IDL> print, b |
---|
226 | ok=111, year=[1997,1998,1999], age_capitaine=35 |
---|
227 | IDL> print, chkeywd(b,'ok','c''est bon') |
---|
228 | ok='c''est bon', year=[1997,1998,1999], age_capitaine=35 |
---|
229 | IDL> print, chkeywd(b,'YEAR',indgen(5),sep='=') |
---|
230 | ok=111, year=[0,1,2,3,4], age_capitaine=35 |
---|
231 | IDL> print, chkeywd(b,'YEAR',indgen(5),sep=']',/after) |
---|
232 | ok=111, year=[0,1,2,3,4], age_capitaine=35 |
---|
233 | IDL> b='ok=111, /year, /age_capitaine' |
---|
234 | IDL> print, chkeywd(b,'year','c''est bon') |
---|
235 | ok=111, year='c''est bon', /age_capitaine |
---|
236 | </div> |
---|
237 | <h3>Version history</h3> |
---|
238 | |
---|
239 | <h4>Version</h4><div class="preformat"> |
---|
240 | $Id: chkeywd.pro 372 2008-08-08 12:31:53Z pinsard $ |
---|
241 | </div> |
---|
242 | <h4>History</h4><div class="preformat"> |
---|
243 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
244 | - 18/10/1999 |
---|
245 | - 24/11/1999: adaptation for keywords starting by / |
---|
246 | </div> |
---|
247 | |
---|
248 | |
---|
249 | <h3>Known issues</h3> |
---|
250 | |
---|
251 | |
---|
252 | |
---|
253 | <h4>Restrictions</h4><div class="preformat"> |
---|
254 | If keywdvalue is an array, it will be convert in a vector. |
---|
255 | |
---|
256 | |
---|
257 | Beware, this function has loops, ifs and cases everywhere. So it can |
---|
258 | not be used by big keywords (with a lot of elements which are big |
---|
259 | arrays). The input keyword must not contain Complex floatings, structure, |
---|
260 | Double-precision complex, Pointer, Object reference, Unsigned Integer, |
---|
261 | Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer. |
---|
262 | |
---|
263 | </div> |
---|
264 | |
---|
265 | <h3>Other attributes</h3> |
---|
266 | |
---|
267 | |
---|
268 | <h4>Uses routines</h4><div class="preformat"> |
---|
269 | <a href="../..//Obsolete/common.html">common</a> |
---|
270 | </div> |
---|
271 | |
---|
272 | |
---|
273 | |
---|
274 | |
---|
275 | <h3>Statistics</h3> |
---|
276 | <table class="statistics"> |
---|
277 | <tr><td>McCabe cyclic</td><td> 8</td></tr> |
---|
278 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
279 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
280 | </table> |
---|
281 | |
---|
282 | |
---|
283 | </div> |
---|
284 | |
---|
285 | </div> |
---|
286 | |
---|
287 | |
---|
288 | |
---|
289 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
290 | |
---|
291 | </div> |
---|
292 | |
---|
293 | </body> |
---|
294 | </html> |
---|