source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strkeywd.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.3 KB
RevLine 
[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>strkeywd.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="strkeywd.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="../../../../ToBeReviewed/STRING//strkeywd.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
[195]74<a href="string2struct.html">&lt;&lt;prev file</a> | <a href="strright.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strkeywd.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;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">ToBeReviewed/STRING/</a></h1>
[89]82      <h2 class="pro_file">strkeywd.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[142]89      <div id="file_comments">
[163]90 Translate a structure in a string able to be used to specify keywords
[142]91 in the calling of a function when we use EXECUTE (see example)
92</div>
[89]93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_strkeywd">
106
[142]107          <h2><a class="top" href="#container">top</a>strkeywd <span class="categories"> 
108 </span></h2>
[89]109       
110          <p class="header">
111            <span class="result">result = </span>strkeywd(<span class="result"><a href="#_strkeywd_param_struct">struct</a></span>)</p>
112       
113          <div class="comments">
[142]114</div>
[89]115
[142]116          <h3>Return value</h3><div class="preformat">
117 a string composed like following:
118 For each element of the structure, we write a part of the string as:
119         'name_of_the_element=content_of_the_element'
[89]120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_strkeywd_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127             
128             
129             
130             
131             
132             
133             
134             
135            </h4>
136       
[142]137          <div class="comments">
138 a structure
139</div>
[89]140           
141
142         
143
144         
145
[142]146          <h3>Examples</h3><div class="preformat">
[402]147
148 We create a structure:
149   IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35)
150   IDL> help, b,/struct
[142]151       ** Structure <817f4bc>, 3 tags, length=10, refs=1:
152          AGE_CAPITAINE   INT             35
153          OK              INT            111
154          YEAR            INT       Array[3]
[402]155
156 We put this structure as a string:
157   IDL> a=strkeywd(b)
158   IDL> print, a
[142]159       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999]
[402]160
[142]161 Now we can use the string a to pass keywords in a function thanks to execute!!
[402]162   IDL> test=execute('c=get_extra('+a+')')
163   IDL> help, c,/struct
[142]164       ** Structure <817f2dc>, 3 tags, length=10, refs=1:
165          AGE_CAPITAINE   INT             35
166          OK              INT            111
167          YEAR            INT       Array[3]
168</div>
169          <h3>Version history</h3>
[89]170         
[142]171          <h4>Version</h4><div class="preformat">
[402]172 $Id: strkeywd.pro 372 2008-08-08 12:31:53Z pinsard $
[142]173</div>
[157]174          <h4>History</h4><div class="preformat">
175 Sebastien Masson (smasson@lodyc.jussieu.fr)
176                      11/10/1999
177</div>
[89]178         
179         
[142]180          <h3>Known issues</h3>
[89]181         
182         
183         
[142]184          <h4>Restrictions</h4><div class="preformat">
[402]185 If an element of the structure contain an array, it will be convert in a
186 vector.
[142]187
188
[402]189 Beware, this function has loops, ifs and cases everywhere. So it can
[142]190 not be used by big keywords (with a lot of elements which are big
191 arrays). The input keyword must not contain Complex floatings, structure,
192 Double-precision complex, Pointer, Object reference, Unsigned Integer,
193 Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer.
194</div>
[89]195       
196         
197         
198         
199         
200         
201         
202         
203       
[163]204          <h3>Statistics</h3>
205          <table class="statistics">
206            <tr><td>McCabe cyclic</td><td>           5</td></tr>
207            <tr><td>McCabe essential</td><td>           1</td></tr>
208            <tr><td>McCabe modular design</td><td>           1</td></tr>
209          </table>
[89]210         
211       
212        </div>
213       
214      </div>
215
216     
217
218      <div id="tagline">Produced by IDLdoc 2.0.</div>
219
220    </div>
221
222  </body>
[249]223</html>
Note: See TracBrowser for help on using the repository browser.