← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_params.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_params.xml
22
22
 * See the file ./license.txt
23
23
 -->
24
24
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="scicos_params">
25
 
  <refnamediv>
26
 
    <refname>scicos_params</refname>
27
 
    <refpurpose>Define a param structure</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection id="Module_scicos_params">
30
 
    <title>Module</title>
31
 
    <itemizedlist>
32
 
      <listitem>
33
 
        <para>
34
 
          <link linkend="xcos">xcos</link>
35
 
        </para>
36
 
      </listitem>
37
 
    </itemizedlist>
38
 
  </refsection>
39
 
  <refsection id="params_scicos_params">
40
 
    <title>params</title>
41
 
    <para>
42
 
Size : 11.
43
 
</para>
44
 
    <para>
45
 
Type : scilab list.
46
 
</para>
47
 
    <para>
48
 
 
49
 
</para>
50
 
    <itemizedlist>
51
 
      <listitem>
52
 
        <para>
53
 
          <emphasis role="bold">wpar</emphasis>
54
 
        </para>
55
 
        <para> This vector is not currently used.</para>
56
 
        <para> It may be used in the future to code window sizes of the editor.</para>
57
 
        <para> 
58
 
Size : 6.
59
 
</para>
60
 
        <para>
61
 
Type : column vector or real.
62
 
</para>
63
 
      </listitem>
64
 
      <listitem>
65
 
        <para>
66
 
          <emphasis role="bold">title</emphasis>
67
 
        </para>
68
 
        <para> Vector of character strings, where the first one is the diagram title and default name of save file name, and the second one is the path of the directory of the file name.</para>
69
 
        <para> 
70
 
Size : 2.
71
 
</para>
72
 
        <para>
73
 
Type : row vector of strings.
74
 
</para>
75
 
      </listitem>
76
 
      <listitem>
77
 
        <para>
78
 
          <emphasis role="bold">tol</emphasis>
79
 
        </para>
80
 
        <para> 
81
 
A vector containing simulation parameters including
82
 
          various tolerances used by the solver: 
83
 
 
84
 
 
85
 
</para>
86
 
        <itemizedlist>
87
 
          <listitem>
88
 
            <para>
89
 
              <emphasis role="bold">atol  </emphasis>
90
 
            </para>
91
 
            <para>
92
 
Integrator absolute tolerance for the numerical solver.
93
 
</para>
94
 
            <para>
95
 
 
96
 
</para>
97
 
          </listitem>
98
 
          <listitem>
99
 
            <para>
100
 
              <emphasis role="bold">rtol  </emphasis>
101
 
            </para>
102
 
            <para>
103
 
Integrator relative tolerance for the numerical solver.
104
 
</para>
105
 
            <para>
106
 
 
107
 
</para>
108
 
          </listitem>
109
 
          <listitem>
110
 
            <para>
111
 
              <emphasis role="bold">ttol  </emphasis>
112
 
            </para>
113
 
            <para>
114
 
Tolerance on time.
115
 
</para>
116
 
            <para>
117
 
If an integration period is less
118
 
                         than ttol, the numerical solver is not called.
119
 
</para>
120
 
            <para>
121
 
 
122
 
</para>
123
 
          </listitem>
124
 
          <listitem>
125
 
            <para>
126
 
              <emphasis role="bold">deltat</emphasis>
127
 
            </para>
128
 
            <para>
129
 
Maximum integration time interval.
130
 
</para>
131
 
            <para>
132
 
If an integration period is larger than
133
 
                         deltat, the numerical solver is called more than
134
 
                         once in such a way that for each call the integration
135
 
                         period remains below deltat
136
 
 
137
 
 
138
 
</para>
139
 
          </listitem>
140
 
          <listitem>
141
 
            <para>
142
 
              <emphasis role="bold">scale </emphasis>
143
 
            </para>
144
 
            <para>
145
 
Real-time scaling; the value 0 corresponds to no
146
 
                         real-time scaling.
147
 
</para>
148
 
            <para>
149
 
It associates a Scicos simulation time to the real
150
 
                         time in seconds.
151
 
</para>
152
 
            <para>
153
 
A value of 1 means that each Scicos unit of time
154
 
                         corresponds to one second.
155
 
</para>
156
 
            <para>
157
 
 
158
 
</para>
159
 
          </listitem>
160
 
          <listitem>
161
 
            <para>
162
 
              <emphasis role="bold">solver</emphasis>
163
 
            </para>
164
 
            <para>
165
 
Choice of numerical solver.
166
 
</para>
167
 
            <para>
168
 
The value 0 implies an ODE solver and 100
169
 
                         implies a DAE solver.
170
 
</para>
171
 
            <para>
172
 
 
173
 
</para>
174
 
          </listitem>
175
 
          <listitem>
176
 
            <para>
177
 
              <emphasis role="bold">hmax  </emphasis>
178
 
            </para>
179
 
            <para>
180
 
Maximum step size for the numerical solver.
181
 
</para>
182
 
            <para>
183
 
0 means no limit.
184
 
</para>
185
 
            <para>
186
 
</para>
187
 
            <para>           
188
 
</para>
189
 
          </listitem>
190
 
        </itemizedlist>
191
 
        <para> 
192
 
Size : 7.
193
 
</para>
194
 
        <para>
195
 
Type : column vector of real.
196
 
</para>
197
 
      </listitem>
198
 
      <listitem>
199
 
        <para>
200
 
          <emphasis role="bold">tf</emphasis>
201
 
        </para>
202
 
        <para> Final time simulation.</para>
203
 
        <para> The simulation stops at this time.</para>
204
 
        <para> The default value is 100000.</para>
205
 
        <para> 
206
 
Size : 1.
207
 
</para>
208
 
        <para>
209
 
Type : real.
210
 
</para>
211
 
      </listitem>
212
 
      <listitem>
213
 
        <para>
214
 
          <emphasis role="bold">context</emphasis>
215
 
        </para>
216
 
        <para> A vector of strings containing Scilab instructions defining Scilab variables to be used inside block's dialog box as symbolic parameters.</para>
217
 
        <para> All valid Scilab instructions can be used and also comments.</para>
218
 
        <para> 
219
 
Size : number of lines of the context.
220
 
</para>
221
 
        <para>
222
 
Type : column vector of strings.
223
 
</para>
224
 
      </listitem>
225
 
      <listitem>
226
 
        <para>
227
 
          <emphasis role="bold">void1</emphasis>
228
 
        </para>
229
 
        <para> unused field.</para>
230
 
        <para> 
231
 
Size : -.
232
 
</para>
233
 
        <para>
234
 
Type : -.
235
 
</para>
236
 
      </listitem>
237
 
      <listitem>
238
 
        <para>
239
 
          <emphasis role="bold">options</emphasis>
240
 
        </para>
241
 
        <para> Scilab object of type scsopt defining graphical properties of the editor such as background color and link color.</para>
242
 
        <para> 
243
 
The fields are the following:
244
 
 
245
 
 
246
 
</para>
247
 
        <itemizedlist>
248
 
          <listitem>
249
 
            <para>
250
 
              <emphasis role="bold">3D        </emphasis>
251
 
            </para>
252
 
            <para>
253
 
A list with two entries. The first one is a boolean
254
 
                             indicating whether or not blocks should have 3D aspect.
255
 
</para>
256
 
            <para>
257
 
The second entry indicates the color in the current colormap
258
 
                             to be used to create the 3D effect.
259
 
</para>
260
 
            <para>
261
 
The default is 33 which corresponds to gray added by
262
 
                             Scicos to the standard colormap, which contains 32 colors.
263
 
</para>
264
 
            <para>
265
 
The default value is list(%t,33).
266
 
</para>
267
 
            <para>
268
 
 
269
 
</para>
270
 
          </listitem>
271
 
          <listitem>
272
 
            <para>
273
 
              <emphasis role="bold">Background</emphasis>
274
 
            </para>
275
 
            <para>
276
 
Vector with two entries: background and
277
 
                             foreground colors.
278
 
</para>
279
 
            <para>
280
 
The default value is [8,1].
281
 
</para>
282
 
            <para>
283
 
 
284
 
</para>
285
 
          </listitem>
286
 
          <listitem>
287
 
            <para>
288
 
              <emphasis role="bold">link      </emphasis>
289
 
            </para>
290
 
            <para>
291
 
Default link colors for regular and activation links.
292
 
</para>
293
 
            <para>
294
 
These colors are used only at link construction.
295
 
</para>
296
 
            <para>
297
 
Changing them does not affect already constructed links.
298
 
</para>
299
 
            <para>
300
 
The default value is [1,5], which corresponds to black and
301
 
                             red if the standard Scilab colormap is used.
302
 
</para>
303
 
            <para>
304
 
 
305
 
</para>
306
 
          </listitem>
307
 
          <listitem>
308
 
            <para>
309
 
              <emphasis role="bold">ID        </emphasis>
310
 
            </para>
311
 
            <para>
312
 
A list of two vectors including font number and sizes.
313
 
</para>
314
 
            <para>
315
 
The default value is [5,1],[4,1].
316
 
</para>
317
 
            <para>
318
 
 
319
 
</para>
320
 
          </listitem>
321
 
          <listitem>
322
 
            <para>
323
 
              <emphasis role="bold">Cmap      </emphasis>
324
 
            </para>
325
 
            <para>
326
 
An n,3 matrix containing RGB values of colors
327
 
                             to be added to the colormap.
328
 
</para>
329
 
            <para>
330
 
The default value is, [0.8,0.8,0.8] i.e., the color gray.
331
 
</para>
332
 
            <para>
333
 
</para>
334
 
            <para>           
335
 
</para>
336
 
          </listitem>
337
 
        </itemizedlist>
338
 
        <para> 
339
 
Size : 6.
340
 
</para>
341
 
        <para>
342
 
Type : scilab tlist of type scsopt.
343
 
</para>
344
 
      </listitem>
345
 
      <listitem>
346
 
        <para>
347
 
          <emphasis role="bold">void2</emphasis>
348
 
        </para>
349
 
        <para> unused field.</para>
350
 
        <para> 
351
 
Size : -.
352
 
</para>
353
 
        <para>
354
 
Type : -.
355
 
</para>
356
 
      </listitem>
357
 
      <listitem>
358
 
        <para>
359
 
          <emphasis role="bold">void3</emphasis>
360
 
        </para>
361
 
        <para> unused field.</para>
362
 
        <para> 
363
 
Size : -.
364
 
</para>
365
 
        <para>
366
 
Type : -.
367
 
</para>
368
 
      </listitem>
369
 
      <listitem>
370
 
        <para>
371
 
          <emphasis role="bold">doc</emphasis>
372
 
        </para>
373
 
        <para> User defined diagram documentation structure.</para>
374
 
        <para> 
375
 
Size : 1.
376
 
</para>
377
 
        <para>
378
 
Type : Strings.
379
 
</para>
380
 
      </listitem>
381
 
    </itemizedlist>
382
 
  </refsection>
383
 
  <refsection id="Filecontent_scicos_params">
384
 
    <title>File content</title>
385
 
    <itemizedlist>
386
 
      <listitem>
387
 
        <para> SCI/modules/scicos/macros/scicos_scicos/scicos_params.sci</para>
388
 
      </listitem>
389
 
    </itemizedlist>
390
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>scicos_params</refname>
 
27
        <refpurpose>Define a param structure</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection id="Module_scicos_params">
 
30
        <title>Module</title>
 
31
        <itemizedlist>
 
32
            <listitem>
 
33
                <para>
 
34
                    <link linkend="xcos">xcos</link>
 
35
                </para>
 
36
            </listitem>
 
37
        </itemizedlist>
 
38
    </refsection>
 
39
    <refsection id="params_scicos_params">
 
40
        <title>params</title>
 
41
        <para>
 
42
            Size : 11.
 
43
        </para>
 
44
        <para>
 
45
            Type : scilab list.
 
46
        </para>
 
47
        <para>
 
48
            
 
49
        </para>
 
50
        <itemizedlist>
 
51
            <listitem>
 
52
                <para>
 
53
                    <emphasis role="bold">wpar</emphasis>
 
54
                </para>
 
55
                <para> This vector is not currently used.</para>
 
56
                <para> It may be used in the future to code window sizes of the editor.</para>
 
57
                <para> 
 
58
                    Size : 6.
 
59
                </para>
 
60
                <para>
 
61
                    Type : column vector or real.
 
62
                </para>
 
63
            </listitem>
 
64
            <listitem>
 
65
                <para>
 
66
                    <emphasis role="bold">title</emphasis>
 
67
                </para>
 
68
                <para> Vector of character strings, where the first one is the diagram title and default name of save file name, and the second one is the path of the directory of the file name.</para>
 
69
                <para> 
 
70
                    Size : 2.
 
71
                </para>
 
72
                <para>
 
73
                    Type : row vector of strings.
 
74
                </para>
 
75
            </listitem>
 
76
            <listitem>
 
77
                <para>
 
78
                    <emphasis role="bold">tol</emphasis>
 
79
                </para>
 
80
                <para> 
 
81
                    A vector containing simulation parameters including
 
82
                    various tolerances used by the solver: 
 
83
                    
 
84
                    
 
85
                </para>
 
86
                <itemizedlist>
 
87
                    <listitem>
 
88
                        <para>
 
89
                            <emphasis role="bold">atol  </emphasis>
 
90
                        </para>
 
91
                        <para>
 
92
                            Integrator absolute tolerance for the numerical solver.
 
93
                        </para>
 
94
                        <para>
 
95
                            
 
96
                        </para>
 
97
                    </listitem>
 
98
                    <listitem>
 
99
                        <para>
 
100
                            <emphasis role="bold">rtol  </emphasis>
 
101
                        </para>
 
102
                        <para>
 
103
                            Integrator relative tolerance for the numerical solver.
 
104
                        </para>
 
105
                        <para>
 
106
                            
 
107
                        </para>
 
108
                    </listitem>
 
109
                    <listitem>
 
110
                        <para>
 
111
                            <emphasis role="bold">ttol  </emphasis>
 
112
                        </para>
 
113
                        <para>
 
114
                            Tolerance on time.
 
115
                        </para>
 
116
                        <para>
 
117
                            If an integration period is less
 
118
                            than ttol, the numerical solver is not called.
 
119
                        </para>
 
120
                        <para>
 
121
                            
 
122
                        </para>
 
123
                    </listitem>
 
124
                    <listitem>
 
125
                        <para>
 
126
                            <emphasis role="bold">deltat</emphasis>
 
127
                        </para>
 
128
                        <para>
 
129
                            Maximum integration time interval.
 
130
                        </para>
 
131
                        <para>
 
132
                            If an integration period is larger than
 
133
                            deltat, the numerical solver is called more than
 
134
                            once in such a way that for each call the integration
 
135
                            period remains below deltat
 
136
                            
 
137
                            
 
138
                        </para>
 
139
                    </listitem>
 
140
                    <listitem>
 
141
                        <para>
 
142
                            <emphasis role="bold">scale </emphasis>
 
143
                        </para>
 
144
                        <para>
 
145
                            Real-time scaling; the value 0 corresponds to no
 
146
                            real-time scaling.
 
147
                        </para>
 
148
                        <para>
 
149
                            It associates a Scicos simulation time to the real
 
150
                            time in seconds.
 
151
                        </para>
 
152
                        <para>
 
153
                            A value of 1 means that each Scicos unit of time
 
154
                            corresponds to one second.
 
155
                        </para>
 
156
                        <para>
 
157
                            
 
158
                        </para>
 
159
                    </listitem>
 
160
                    <listitem>
 
161
                        <para>
 
162
                            <emphasis role="bold">solver</emphasis>
 
163
                        </para>
 
164
                        <para>
 
165
                            Choice of numerical solver.
 
166
                        </para>
 
167
                        <para>
 
168
                            The value 0 implies an ODE solver and 100
 
169
                            implies a DAE solver.
 
170
                        </para>
 
171
                        <para>
 
172
                            
 
173
                        </para>
 
174
                    </listitem>
 
175
                    <listitem>
 
176
                        <para>
 
177
                            <emphasis role="bold">hmax  </emphasis>
 
178
                        </para>
 
179
                        <para>
 
180
                            Maximum step size for the numerical solver.
 
181
                        </para>
 
182
                        <para>
 
183
                            0 means no limit.
 
184
                        </para>
 
185
                        <para>
 
186
                        </para>
 
187
                        <para>           
 
188
                        </para>
 
189
                    </listitem>
 
190
                </itemizedlist>
 
191
                <para> 
 
192
                    Size : 7.
 
193
                </para>
 
194
                <para>
 
195
                    Type : column vector of real.
 
196
                </para>
 
197
            </listitem>
 
198
            <listitem>
 
199
                <para>
 
200
                    <emphasis role="bold">tf</emphasis>
 
201
                </para>
 
202
                <para> Final time simulation.</para>
 
203
                <para> The simulation stops at this time.</para>
 
204
                <para> The default value is 100000.</para>
 
205
                <para> 
 
206
                    Size : 1.
 
207
                </para>
 
208
                <para>
 
209
                    Type : real.
 
210
                </para>
 
211
            </listitem>
 
212
            <listitem>
 
213
                <para>
 
214
                    <emphasis role="bold">context</emphasis>
 
215
                </para>
 
216
                <para> A vector of strings containing Scilab instructions defining Scilab variables to be used inside block's dialog box as symbolic parameters.</para>
 
217
                <para> All valid Scilab instructions can be used and also comments.</para>
 
218
                <para> 
 
219
                    Size : number of lines of the context.
 
220
                </para>
 
221
                <para>
 
222
                    Type : column vector of strings.
 
223
                </para>
 
224
            </listitem>
 
225
            <listitem>
 
226
                <para>
 
227
                    <emphasis role="bold">void1</emphasis>
 
228
                </para>
 
229
                <para> unused field.</para>
 
230
                <para> 
 
231
                    Size : -.
 
232
                </para>
 
233
                <para>
 
234
                    Type : -.
 
235
                </para>
 
236
            </listitem>
 
237
            <listitem>
 
238
                <para>
 
239
                    <emphasis role="bold">options</emphasis>
 
240
                </para>
 
241
                <para> Scilab object of type scsopt defining graphical properties of the editor such as background color and link color.</para>
 
242
                <para> 
 
243
                    The fields are the following:
 
244
                    
 
245
                    
 
246
                </para>
 
247
                <itemizedlist>
 
248
                    <listitem>
 
249
                        <para>
 
250
                            <emphasis role="bold">3D        </emphasis>
 
251
                        </para>
 
252
                        <para>
 
253
                            A list with two entries. The first one is a boolean
 
254
                            indicating whether or not blocks should have 3D aspect.
 
255
                        </para>
 
256
                        <para>
 
257
                            The second entry indicates the color in the current colormap
 
258
                            to be used to create the 3D effect.
 
259
                        </para>
 
260
                        <para>
 
261
                            The default is 33 which corresponds to gray added by
 
262
                            Scicos to the standard colormap, which contains 32 colors.
 
263
                        </para>
 
264
                        <para>
 
265
                            The default value is list(%t,33).
 
266
                        </para>
 
267
                        <para>
 
268
                            
 
269
                        </para>
 
270
                    </listitem>
 
271
                    <listitem>
 
272
                        <para>
 
273
                            <emphasis role="bold">Background</emphasis>
 
274
                        </para>
 
275
                        <para>
 
276
                            Vector with two entries: background and
 
277
                            foreground colors.
 
278
                        </para>
 
279
                        <para>
 
280
                            The default value is [8,1].
 
281
                        </para>
 
282
                        <para>
 
283
                            
 
284
                        </para>
 
285
                    </listitem>
 
286
                    <listitem>
 
287
                        <para>
 
288
                            <emphasis role="bold">link      </emphasis>
 
289
                        </para>
 
290
                        <para>
 
291
                            Default link colors for regular and activation links.
 
292
                        </para>
 
293
                        <para>
 
294
                            These colors are used only at link construction.
 
295
                        </para>
 
296
                        <para>
 
297
                            Changing them does not affect already constructed links.
 
298
                        </para>
 
299
                        <para>
 
300
                            The default value is [1,5], which corresponds to black and
 
301
                            red if the standard Scilab colormap is used.
 
302
                        </para>
 
303
                        <para>
 
304
                            
 
305
                        </para>
 
306
                    </listitem>
 
307
                    <listitem>
 
308
                        <para>
 
309
                            <emphasis role="bold">ID        </emphasis>
 
310
                        </para>
 
311
                        <para>
 
312
                            A list of two vectors including font number and sizes.
 
313
                        </para>
 
314
                        <para>
 
315
                            The default value is [5,1],[4,1].
 
316
                        </para>
 
317
                        <para>
 
318
                            
 
319
                        </para>
 
320
                    </listitem>
 
321
                    <listitem>
 
322
                        <para>
 
323
                            <emphasis role="bold">Cmap      </emphasis>
 
324
                        </para>
 
325
                        <para>
 
326
                            An n,3 matrix containing RGB values of colors
 
327
                            to be added to the colormap.
 
328
                        </para>
 
329
                        <para>
 
330
                            The default value is, [0.8,0.8,0.8] i.e., the color gray.
 
331
                        </para>
 
332
                        <para>
 
333
                        </para>
 
334
                        <para>           
 
335
                        </para>
 
336
                    </listitem>
 
337
                </itemizedlist>
 
338
                <para> 
 
339
                    Size : 6.
 
340
                </para>
 
341
                <para>
 
342
                    Type : scilab tlist of type scsopt.
 
343
                </para>
 
344
            </listitem>
 
345
            <listitem>
 
346
                <para>
 
347
                    <emphasis role="bold">void2</emphasis>
 
348
                </para>
 
349
                <para> unused field.</para>
 
350
                <para> 
 
351
                    Size : -.
 
352
                </para>
 
353
                <para>
 
354
                    Type : -.
 
355
                </para>
 
356
            </listitem>
 
357
            <listitem>
 
358
                <para>
 
359
                    <emphasis role="bold">void3</emphasis>
 
360
                </para>
 
361
                <para> unused field.</para>
 
362
                <para> 
 
363
                    Size : -.
 
364
                </para>
 
365
                <para>
 
366
                    Type : -.
 
367
                </para>
 
368
            </listitem>
 
369
            <listitem>
 
370
                <para>
 
371
                    <emphasis role="bold">doc</emphasis>
 
372
                </para>
 
373
                <para> User defined diagram documentation structure.</para>
 
374
                <para> 
 
375
                    Size : 1.
 
376
                </para>
 
377
                <para>
 
378
                    Type : Strings.
 
379
                </para>
 
380
            </listitem>
 
381
        </itemizedlist>
 
382
    </refsection>
 
383
    <refsection id="Filecontent_scicos_params">
 
384
        <title>File content</title>
 
385
        <itemizedlist>
 
386
            <listitem>
 
387
                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_params.sci</para>
 
388
            </listitem>
 
389
        </itemizedlist>
 
390
    </refsection>
391
391
</refentry>