← 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/palettes/Continuous_pal/TCLSS.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/palettes/Continuous_pal/TCLSS.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="TCLSS">
25
 
  <refnamediv>
26
 
    <refname>TCLSS</refname>
27
 
    <refpurpose>Continuous linear system with jump</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/TCLSS.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_TCLSS">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="TCLSS">Continuous linear system with jump</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_TCLSS">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_TCLSS">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_TCLSS">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_TCLSS">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_TCLSS">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_TCLSS">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Example_TCLSS">Example</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_TCLSS">
89
 
    <title>Palette</title>
90
 
    <itemizedlist>
91
 
      <listitem>
92
 
        <para>
93
 
          <link linkend="Continuous_pal">Continuous time systems palette</link>
94
 
        </para>
95
 
      </listitem>
96
 
    </itemizedlist>
97
 
  </refsection>
98
 
  <refsection id="Description_TCLSS">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      This block realizes a continuous-time linear state-space system with
102
 
      the possibility of jumps in the state. The number of inputs to this
103
 
      block is two. The first input is the regular input of the linear
104
 
      system, the second carries the new value of the state which is copied
105
 
      into the state when an event arrives at the unique event input port of
106
 
      this block. That means the state of the system jumps to the value
107
 
      present on the second input (of size equal to that of the state). The
108
 
      system is defined by the  matrices and the initial state
109
 
      . The dimensions must be compatible. The sizes of inputs and outputs
110
 
      are adjusted automatically.
111
 
    </para>
112
 
  </refsection>
113
 
  <refsection id="Dialogbox_TCLSS">
114
 
    <title>Dialog box</title>
115
 
    <para>
116
 
      <inlinemediaobject>
117
 
        <imageobject>
118
 
          <imagedata fileref="../../../../images/gui/TCLSS_gui.gif" align="center" valign="middle"/>
119
 
        </imageobject>
120
 
      </inlinemediaobject>
121
 
    </para>
122
 
    <para>
123
 
      
124
 
    </para>
125
 
    <itemizedlist>
126
 
      <listitem>
127
 
        <para>
128
 
          <emphasis role="bold">A matrix</emphasis>
129
 
        </para>
130
 
        <para>
131
 
          <inlinemediaobject>
132
 
            <imageobject>
133
 
              <imagedata fileref="../../../images/TCLSS_img5_eng.gif" align="center" valign="middle"/>
134
 
            </imageobject>
135
 
          </inlinemediaobject>
136
 
          square matrix.
137
 
        </para>
138
 
        <para> Properties : Type 'mat' of size [-1,-1]. </para>
139
 
      </listitem>
140
 
      <listitem>
141
 
        <para>
142
 
          <emphasis role="bold">B matrix</emphasis>
143
 
        </para>
144
 
        <para>
145
 
          The
146
 
          <inlinemediaobject>
147
 
            <imageobject>
148
 
              <imagedata fileref="../../../images/TCLSS_img6_eng.gif" align="center" valign="middle"/>
149
 
            </imageobject>
150
 
          </inlinemediaobject>
151
 
          matrix, [] if system has no input.
152
 
        </para>
153
 
        <para> Properties : Type 'mat' of size ["size(%1,2)","-1"]. </para>
154
 
      </listitem>
155
 
      <listitem>
156
 
        <para>
157
 
          <emphasis role="bold">C matrix</emphasis>
158
 
        </para>
159
 
        <para>
160
 
          The
161
 
          <inlinemediaobject>
162
 
            <imageobject>
163
 
              <imagedata fileref="../../../images/TCLSS_img7_eng.gif" align="center" valign="middle"/>
164
 
            </imageobject>
165
 
          </inlinemediaobject>
166
 
          matrix , [] if system has no output.
167
 
        </para>
168
 
        <para> Properties : Type 'mat' of size ["-1","size(%1,2)"]. </para>
169
 
      </listitem>
170
 
      <listitem>
171
 
        <para>
172
 
          <emphasis role="bold">D matrix</emphasis>
173
 
        </para>
174
 
        <para>
175
 
          The
176
 
          <inlinemediaobject>
177
 
            <imageobject>
178
 
              <imagedata fileref="../../../images/TCLSS_img8_eng.gif" align="center" valign="middle"/>
179
 
            </imageobject>
180
 
          </inlinemediaobject>
181
 
          matrix, [] if system has no D term.
182
 
        </para>
183
 
        <para> Properties : Type 'mat' of size [-1,-1]. </para>
184
 
      </listitem>
185
 
      <listitem>
186
 
        <para>
187
 
          <emphasis role="bold">Initial state</emphasis>
188
 
        </para>
189
 
        <para> A vector/scalar initial state of the system.</para>
190
 
        <para> Properties : Type 'vec' of size "size(%1,2)". </para>
191
 
      </listitem>
192
 
    </itemizedlist>
193
 
  </refsection>
194
 
  <refsection id="Defaultproperties_TCLSS">
195
 
    <title>Default properties</title>
196
 
    <itemizedlist>
197
 
      <listitem>
198
 
        <para>
199
 
          <emphasis role="bold">always active:</emphasis> yes
200
 
        </para>
201
 
      </listitem>
202
 
      <listitem>
203
 
        <para>
204
 
          <emphasis role="bold">direct-feedthrough:</emphasis> no
205
 
        </para>
206
 
      </listitem>
207
 
      <listitem>
208
 
        <para>
209
 
          <emphasis role="bold">zero-crossing:</emphasis> no
210
 
        </para>
211
 
      </listitem>
212
 
      <listitem>
213
 
        <para>
214
 
          <emphasis role="bold">mode:</emphasis> no
215
 
        </para>
216
 
      </listitem>
217
 
      <listitem>
218
 
        <para>
219
 
          <emphasis role="bold">regular inputs:</emphasis>
220
 
        </para>
221
 
        <para>
222
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
223
 
        </para>
224
 
        <para>
225
 
          <emphasis role="bold">- port 2 : size [1,1] / type 1</emphasis>
226
 
        </para>
227
 
      </listitem>
228
 
      <listitem>
229
 
        <para>
230
 
          <emphasis role="bold">regular outputs:</emphasis>
231
 
        </para>
232
 
        <para>
233
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
234
 
        </para>
235
 
      </listitem>
236
 
      <listitem>
237
 
        <para>
238
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
239
 
        </para>
240
 
      </listitem>
241
 
      <listitem>
242
 
        <para>
243
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
244
 
        </para>
245
 
      </listitem>
246
 
      <listitem>
247
 
        <para>
248
 
          <emphasis role="bold">continuous-time state:</emphasis> yes
249
 
        </para>
250
 
      </listitem>
251
 
      <listitem>
252
 
        <para>
253
 
          <emphasis role="bold">discrete-time state:</emphasis> no
254
 
        </para>
255
 
      </listitem>
256
 
      <listitem>
257
 
        <para>
258
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
259
 
        </para>
260
 
      </listitem>
261
 
      <listitem>
262
 
        <para>
263
 
          <emphasis role="bold">name of computational function:</emphasis>
264
 
          <emphasis role="italic">tcslti4</emphasis>
265
 
        </para>
266
 
      </listitem>
267
 
    </itemizedlist>
268
 
  </refsection>
269
 
  <refsection id="Interfacingfunction_TCLSS">
270
 
    <title>Interfacing function</title>
271
 
    <itemizedlist>
272
 
      <listitem>
273
 
        <para> SCI/modules/scicos_blocks/macros/Linear/TCLSS.sci</para>
274
 
      </listitem>
275
 
    </itemizedlist>
276
 
  </refsection>
277
 
  <refsection id="Computationalfunction_TCLSS">
278
 
    <title>Computational function</title>
279
 
    <itemizedlist>
280
 
      <listitem>
281
 
        <para> SCI/modules/scicos_blocks/src/c/tcslti4.c (Type 4)</para>
282
 
      </listitem>
283
 
    </itemizedlist>
284
 
  </refsection>
285
 
  <refsection id="Example_TCLSS">
286
 
    <title>Example</title>
287
 
    <para>
288
 
      <link type="scilab" linkend="scilab.xcos/xcos/examples/continuous_pal/TCLSS_Example.xcos">
289
 
        <inlinemediaobject>
290
 
          <imageobject>
291
 
            <imagedata align="center" fileref="../../../../examples/continuous_pal/TCLSS_Example.png" valign="middle"/>
292
 
          </imageobject>
293
 
        </inlinemediaobject>
294
 
      </link>
295
 
    </para>
296
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>TCLSS</refname>
 
27
        <refpurpose>Continuous linear system with jump</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/TCLSS.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_TCLSS">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="TCLSS">Continuous linear system with jump</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_TCLSS">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_TCLSS">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_TCLSS">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_TCLSS">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_TCLSS">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_TCLSS">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Example_TCLSS">Example</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_TCLSS">
 
89
        <title>Palette</title>
 
90
        <itemizedlist>
 
91
            <listitem>
 
92
                <para>
 
93
                    <link linkend="Continuous_pal">Continuous time systems palette</link>
 
94
                </para>
 
95
            </listitem>
 
96
        </itemizedlist>
 
97
    </refsection>
 
98
    <refsection id="Description_TCLSS">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            This block realizes a continuous-time linear state-space system with
 
102
            the possibility of jumps in the state. The number of inputs to this
 
103
            block is two. The first input is the regular input of the linear
 
104
            system, the second carries the new value of the state which is copied
 
105
            into the state when an event arrives at the unique event input port of
 
106
            this block. That means the state of the system jumps to the value
 
107
            present on the second input (of size equal to that of the state). The
 
108
            system is defined by the  matrices and the initial state
 
109
            . The dimensions must be compatible. The sizes of inputs and outputs
 
110
            are adjusted automatically.
 
111
        </para>
 
112
    </refsection>
 
113
    <refsection id="Dialogbox_TCLSS">
 
114
        <title>Dialog box</title>
 
115
        <para>
 
116
            <inlinemediaobject>
 
117
                <imageobject>
 
118
                    <imagedata fileref="../../../../images/gui/TCLSS_gui.gif" align="center" valign="middle"/>
 
119
                </imageobject>
 
120
            </inlinemediaobject>
 
121
        </para>
 
122
        <para>
 
123
            
 
124
        </para>
 
125
        <itemizedlist>
 
126
            <listitem>
 
127
                <para>
 
128
                    <emphasis role="bold">A matrix</emphasis>
 
129
                </para>
 
130
                <para>
 
131
                    <inlinemediaobject>
 
132
                        <imageobject>
 
133
                            <imagedata fileref="../../../images/TCLSS_img5_eng.gif" align="center" valign="middle"/>
 
134
                        </imageobject>
 
135
                    </inlinemediaobject>
 
136
                    square matrix.
 
137
                </para>
 
138
                <para> Properties : Type 'mat' of size [-1,-1]. </para>
 
139
            </listitem>
 
140
            <listitem>
 
141
                <para>
 
142
                    <emphasis role="bold">B matrix</emphasis>
 
143
                </para>
 
144
                <para>
 
145
                    The
 
146
                    <inlinemediaobject>
 
147
                        <imageobject>
 
148
                            <imagedata fileref="../../../images/TCLSS_img6_eng.gif" align="center" valign="middle"/>
 
149
                        </imageobject>
 
150
                    </inlinemediaobject>
 
151
                    matrix, [] if system has no input.
 
152
                </para>
 
153
                <para> Properties : Type 'mat' of size ["size(%1,2)","-1"]. </para>
 
154
            </listitem>
 
155
            <listitem>
 
156
                <para>
 
157
                    <emphasis role="bold">C matrix</emphasis>
 
158
                </para>
 
159
                <para>
 
160
                    The
 
161
                    <inlinemediaobject>
 
162
                        <imageobject>
 
163
                            <imagedata fileref="../../../images/TCLSS_img7_eng.gif" align="center" valign="middle"/>
 
164
                        </imageobject>
 
165
                    </inlinemediaobject>
 
166
                    matrix , [] if system has no output.
 
167
                </para>
 
168
                <para> Properties : Type 'mat' of size ["-1","size(%1,2)"]. </para>
 
169
            </listitem>
 
170
            <listitem>
 
171
                <para>
 
172
                    <emphasis role="bold">D matrix</emphasis>
 
173
                </para>
 
174
                <para>
 
175
                    The
 
176
                    <inlinemediaobject>
 
177
                        <imageobject>
 
178
                            <imagedata fileref="../../../images/TCLSS_img8_eng.gif" align="center" valign="middle"/>
 
179
                        </imageobject>
 
180
                    </inlinemediaobject>
 
181
                    matrix, [] if system has no D term.
 
182
                </para>
 
183
                <para> Properties : Type 'mat' of size [-1,-1]. </para>
 
184
            </listitem>
 
185
            <listitem>
 
186
                <para>
 
187
                    <emphasis role="bold">Initial state</emphasis>
 
188
                </para>
 
189
                <para> A vector/scalar initial state of the system.</para>
 
190
                <para> Properties : Type 'vec' of size "size(%1,2)". </para>
 
191
            </listitem>
 
192
        </itemizedlist>
 
193
    </refsection>
 
194
    <refsection id="Defaultproperties_TCLSS">
 
195
        <title>Default properties</title>
 
196
        <itemizedlist>
 
197
            <listitem>
 
198
                <para>
 
199
                    <emphasis role="bold">always active:</emphasis> yes
 
200
                </para>
 
201
            </listitem>
 
202
            <listitem>
 
203
                <para>
 
204
                    <emphasis role="bold">direct-feedthrough:</emphasis> no
 
205
                </para>
 
206
            </listitem>
 
207
            <listitem>
 
208
                <para>
 
209
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
210
                </para>
 
211
            </listitem>
 
212
            <listitem>
 
213
                <para>
 
214
                    <emphasis role="bold">mode:</emphasis> no
 
215
                </para>
 
216
            </listitem>
 
217
            <listitem>
 
218
                <para>
 
219
                    <emphasis role="bold">regular inputs:</emphasis>
 
220
                </para>
 
221
                <para>
 
222
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
223
                </para>
 
224
                <para>
 
225
                    <emphasis role="bold">- port 2 : size [1,1] / type 1</emphasis>
 
226
                </para>
 
227
            </listitem>
 
228
            <listitem>
 
229
                <para>
 
230
                    <emphasis role="bold">regular outputs:</emphasis>
 
231
                </para>
 
232
                <para>
 
233
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
234
                </para>
 
235
            </listitem>
 
236
            <listitem>
 
237
                <para>
 
238
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
 
239
                </para>
 
240
            </listitem>
 
241
            <listitem>
 
242
                <para>
 
243
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
244
                </para>
 
245
            </listitem>
 
246
            <listitem>
 
247
                <para>
 
248
                    <emphasis role="bold">continuous-time state:</emphasis> yes
 
249
                </para>
 
250
            </listitem>
 
251
            <listitem>
 
252
                <para>
 
253
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
254
                </para>
 
255
            </listitem>
 
256
            <listitem>
 
257
                <para>
 
258
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
259
                </para>
 
260
            </listitem>
 
261
            <listitem>
 
262
                <para>
 
263
                    <emphasis role="bold">name of computational function:</emphasis>
 
264
                    <emphasis role="italic">tcslti4</emphasis>
 
265
                </para>
 
266
            </listitem>
 
267
        </itemizedlist>
 
268
    </refsection>
 
269
    <refsection id="Interfacingfunction_TCLSS">
 
270
        <title>Interfacing function</title>
 
271
        <itemizedlist>
 
272
            <listitem>
 
273
                <para> SCI/modules/scicos_blocks/macros/Linear/TCLSS.sci</para>
 
274
            </listitem>
 
275
        </itemizedlist>
 
276
    </refsection>
 
277
    <refsection id="Computationalfunction_TCLSS">
 
278
        <title>Computational function</title>
 
279
        <itemizedlist>
 
280
            <listitem>
 
281
                <para> SCI/modules/scicos_blocks/src/c/tcslti4.c (Type 4)</para>
 
282
            </listitem>
 
283
        </itemizedlist>
 
284
    </refsection>
 
285
    <refsection id="Example_TCLSS">
 
286
        <title>Example</title>
 
287
        <para>
 
288
            <link type="scilab" linkend="scilab.xcos/xcos/examples/continuous_pal/TCLSS_Example.xcos">
 
289
                <inlinemediaobject>
 
290
                    <imageobject>
 
291
                        <imagedata align="center" fileref="../../../../examples/continuous_pal/TCLSS_Example.png" valign="middle"/>
 
292
                    </imageobject>
 
293
                </inlinemediaobject>
 
294
            </link>
 
295
        </para>
 
296
    </refsection>
297
297
</refentry>