← 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/Sinks_pal/TOWS_c.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/Sinks_pal/TOWS_c.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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="TOWS_c">
25
 
  <refnamediv>
26
 
    <refname>TOWS_c</refname>
27
 
    <refpurpose>Data to Scilab worspace</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata align="center" fileref="../../../../images/palettes/TOWS_c.png" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_TOWS_c">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="TOWS_c">Data to Scilab worspace</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_TOWS_c">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_TOWS_c">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_TOWS_c">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_TOWS_c">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_TOWS_c">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_TOWS_c">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Example_TOWS_c">Example</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_TOWS_c">
89
 
    <title>Palette</title>
90
 
    <itemizedlist>
91
 
      <listitem>
92
 
        <para>
93
 
          <link linkend="Sinks_pal">Sinks palette</link>
94
 
        </para>
95
 
      </listitem>
96
 
    </itemizedlist>
97
 
  </refsection>
98
 
  <refsection id="Description_TOWS_c">
99
 
    <title>Description</title>
100
 
    <para>That block is used to put simulated data in the scilab
101
 
      workspace.
102
 
    </para>
103
 
    <para>Each sampling time, both dates and values of input are
104
 
      recorded.
105
 
    </para>
106
 
  </refsection>
107
 
  <refsection id="Dialogbox_TOWS_c">
108
 
    <title>Dialog box</title>
109
 
    <para>
110
 
      <inlinemediaobject>
111
 
        <imageobject>
112
 
          <imagedata align="center" fileref="../../../../images/gui/TOWS_c_gui.gif" valign="middle"/>
113
 
        </imageobject>
114
 
      </inlinemediaobject>
115
 
    </para>
116
 
    <para/>
117
 
    <itemizedlist>
118
 
      <listitem>
119
 
        <para>
120
 
          <emphasis role="bold">Size of buffer</emphasis>
121
 
        </para>
122
 
        <para>Set the size of the input buffer. That gives the total number of
123
 
          samples recorded during the simulation.
124
 
        </para>
125
 
        <para>That buffer is a circulate buffer.</para>
126
 
        <para>Properties : Type 'vec' of size 1.</para>
127
 
      </listitem>
128
 
      <listitem>
129
 
        <para>
130
 
          <emphasis role="bold">Scilab variable name</emphasis>
131
 
        </para>
132
 
        <para>Set the name of the Scilab variable. This must be a valid
133
 
          variable name.
134
 
        </para>
135
 
        <para>The simulation must be finished to retrieve that variable in the
136
 
          Scilab workspace.
137
 
        </para>
138
 
        <para>Properties : Type 'str' of size 1.</para>
139
 
      </listitem>
140
 
      <listitem>
141
 
        <para>
142
 
          <emphasis role="bold">Inherit (no:0, yes:1)</emphasis>
143
 
        </para>
144
 
        <para>Options to choose event inheritance from regular input or from
145
 
          explicit event input (0).
146
 
        </para>
147
 
        <para>Properties : Type 'vec' of size 1.</para>
148
 
      </listitem>
149
 
    </itemizedlist>
150
 
  </refsection>
151
 
  <refsection id="Defaultproperties_TOWS_c">
152
 
    <title>Default properties</title>
153
 
    <itemizedlist>
154
 
      <listitem>
155
 
        <para>
156
 
          <emphasis role="bold">always active:</emphasis> no
157
 
        </para>
158
 
      </listitem>
159
 
      <listitem>
160
 
        <para>
161
 
          <emphasis role="bold">direct-feedthrough:</emphasis> no
162
 
        </para>
163
 
      </listitem>
164
 
      <listitem>
165
 
        <para>
166
 
          <emphasis role="bold">zero-crossing:</emphasis> no
167
 
        </para>
168
 
      </listitem>
169
 
      <listitem>
170
 
        <para>
171
 
          <emphasis role="bold">mode:</emphasis> no
172
 
        </para>
173
 
      </listitem>
174
 
      <listitem>
175
 
        <para>
176
 
          <emphasis role="bold">regular inputs:</emphasis>
177
 
        </para>
178
 
        <para>
179
 
          <emphasis role="bold">- port 1 : size [-1,1] / type
180
 
            -1
181
 
          </emphasis>
182
 
        </para>
183
 
      </listitem>
184
 
      <listitem>
185
 
        <para>
186
 
          <emphasis role="bold">number/sizes of activation
187
 
            inputs:
188
 
          </emphasis>
189
 
          1
190
 
        </para>
191
 
      </listitem>
192
 
      <listitem>
193
 
        <para>
194
 
          <emphasis role="bold">number/sizes of activation
195
 
            outputs:
196
 
          </emphasis>
197
 
          0
198
 
        </para>
199
 
      </listitem>
200
 
      <listitem>
201
 
        <para>
202
 
          <emphasis role="bold">continuous-time state:</emphasis>
203
 
          no
204
 
        </para>
205
 
      </listitem>
206
 
      <listitem>
207
 
        <para>
208
 
          <emphasis role="bold">discrete-time state:</emphasis> no
209
 
        </para>
210
 
      </listitem>
211
 
      <listitem>
212
 
        <para>
213
 
          <emphasis role="bold">object discrete-time state:</emphasis>
214
 
          no
215
 
        </para>
216
 
      </listitem>
217
 
      <listitem>
218
 
        <para>
219
 
          <emphasis role="bold">name of computational function:</emphasis>
220
 
          <emphasis role="italic">tows_c</emphasis>
221
 
        </para>
222
 
      </listitem>
223
 
    </itemizedlist>
224
 
  </refsection>
225
 
  <refsection id="Interfacingfunction_TOWS_c">
226
 
    <title>Interfacing function</title>
227
 
    <itemizedlist>
228
 
      <listitem>
229
 
        <para>SCI/modules/scicos_blocks/macros/Sinks/TOWS_c.sci</para>
230
 
      </listitem>
231
 
    </itemizedlist>
232
 
  </refsection>
233
 
  <refsection id="Computationalfunction_TOWS_c">
234
 
    <title>Computational function</title>
235
 
    <itemizedlist>
236
 
      <listitem>
237
 
        <para>SCI/modules/scicos_blocks/src/c/tows_c.c (Type 4)</para>
238
 
      </listitem>
239
 
    </itemizedlist>
240
 
  </refsection>
241
 
  <refsection id="Example_TOWS_c">
242
 
    <title>Example</title>
243
 
    <para>
244
 
      <link type="scilab" linkend="scilab.xcos/xcos/examples/sinks_pal/TOWS_c_Example.xcos">
245
 
        <inlinemediaobject>
246
 
          <imageobject>
247
 
            <imagedata align="center" fileref="../../../../examples/sinks_pal/TOWS_c_Example.png" valign="middle"/>
248
 
          </imageobject>
249
 
        </inlinemediaobject>
250
 
      </link>
251
 
    </para>
252
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>TOWS_c</refname>
 
27
        <refpurpose>Data to Scilab worspace</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata align="center" fileref="../../../../images/palettes/TOWS_c.png" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_TOWS_c">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="TOWS_c">Data to Scilab worspace</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_TOWS_c">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_TOWS_c">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_TOWS_c">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_TOWS_c">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_TOWS_c">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_TOWS_c">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Example_TOWS_c">Example</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_TOWS_c">
 
89
        <title>Palette</title>
 
90
        <itemizedlist>
 
91
            <listitem>
 
92
                <para>
 
93
                    <link linkend="Sinks_pal">Sinks palette</link>
 
94
                </para>
 
95
            </listitem>
 
96
        </itemizedlist>
 
97
    </refsection>
 
98
    <refsection id="Description_TOWS_c">
 
99
        <title>Description</title>
 
100
        <para>That block is used to put simulated data in the scilab
 
101
            workspace.
 
102
        </para>
 
103
        <para>Each sampling time, both dates and values of input are
 
104
            recorded.
 
105
        </para>
 
106
    </refsection>
 
107
    <refsection id="Dialogbox_TOWS_c">
 
108
        <title>Dialog box</title>
 
109
        <para>
 
110
            <inlinemediaobject>
 
111
                <imageobject>
 
112
                    <imagedata align="center" fileref="../../../../images/gui/TOWS_c_gui.gif" valign="middle"/>
 
113
                </imageobject>
 
114
            </inlinemediaobject>
 
115
        </para>
 
116
        <para/>
 
117
        <itemizedlist>
 
118
            <listitem>
 
119
                <para>
 
120
                    <emphasis role="bold">Size of buffer</emphasis>
 
121
                </para>
 
122
                <para>Set the size of the input buffer. That gives the total number of
 
123
                    samples recorded during the simulation.
 
124
                </para>
 
125
                <para>That buffer is a circulate buffer.</para>
 
126
                <para>Properties : Type 'vec' of size 1.</para>
 
127
            </listitem>
 
128
            <listitem>
 
129
                <para>
 
130
                    <emphasis role="bold">Scilab variable name</emphasis>
 
131
                </para>
 
132
                <para>Set the name of the Scilab variable. This must be a valid
 
133
                    variable name.
 
134
                </para>
 
135
                <para>The simulation must be finished to retrieve that variable in the
 
136
                    Scilab workspace.
 
137
                </para>
 
138
                <para>Properties : Type 'str' of size 1.</para>
 
139
            </listitem>
 
140
            <listitem>
 
141
                <para>
 
142
                    <emphasis role="bold">Inherit (no:0, yes:1)</emphasis>
 
143
                </para>
 
144
                <para>Options to choose event inheritance from regular input or from
 
145
                    explicit event input (0).
 
146
                </para>
 
147
                <para>Properties : Type 'vec' of size 1.</para>
 
148
            </listitem>
 
149
        </itemizedlist>
 
150
    </refsection>
 
151
    <refsection id="Defaultproperties_TOWS_c">
 
152
        <title>Default properties</title>
 
153
        <itemizedlist>
 
154
            <listitem>
 
155
                <para>
 
156
                    <emphasis role="bold">always active:</emphasis> no
 
157
                </para>
 
158
            </listitem>
 
159
            <listitem>
 
160
                <para>
 
161
                    <emphasis role="bold">direct-feedthrough:</emphasis> no
 
162
                </para>
 
163
            </listitem>
 
164
            <listitem>
 
165
                <para>
 
166
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
167
                </para>
 
168
            </listitem>
 
169
            <listitem>
 
170
                <para>
 
171
                    <emphasis role="bold">mode:</emphasis> no
 
172
                </para>
 
173
            </listitem>
 
174
            <listitem>
 
175
                <para>
 
176
                    <emphasis role="bold">regular inputs:</emphasis>
 
177
                </para>
 
178
                <para>
 
179
                    <emphasis role="bold">- port 1 : size [-1,1] / type
 
180
                        -1
 
181
                    </emphasis>
 
182
                </para>
 
183
            </listitem>
 
184
            <listitem>
 
185
                <para>
 
186
                    <emphasis role="bold">number/sizes of activation
 
187
                        inputs:
 
188
                    </emphasis>
 
189
                    1
 
190
                </para>
 
191
            </listitem>
 
192
            <listitem>
 
193
                <para>
 
194
                    <emphasis role="bold">number/sizes of activation
 
195
                        outputs:
 
196
                    </emphasis>
 
197
                    0
 
198
                </para>
 
199
            </listitem>
 
200
            <listitem>
 
201
                <para>
 
202
                    <emphasis role="bold">continuous-time state:</emphasis>
 
203
                    no
 
204
                </para>
 
205
            </listitem>
 
206
            <listitem>
 
207
                <para>
 
208
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
209
                </para>
 
210
            </listitem>
 
211
            <listitem>
 
212
                <para>
 
213
                    <emphasis role="bold">object discrete-time state:</emphasis>
 
214
                    no
 
215
                </para>
 
216
            </listitem>
 
217
            <listitem>
 
218
                <para>
 
219
                    <emphasis role="bold">name of computational function:</emphasis>
 
220
                    <emphasis role="italic">tows_c</emphasis>
 
221
                </para>
 
222
            </listitem>
 
223
        </itemizedlist>
 
224
    </refsection>
 
225
    <refsection id="Interfacingfunction_TOWS_c">
 
226
        <title>Interfacing function</title>
 
227
        <itemizedlist>
 
228
            <listitem>
 
229
                <para>SCI/modules/scicos_blocks/macros/Sinks/TOWS_c.sci</para>
 
230
            </listitem>
 
231
        </itemizedlist>
 
232
    </refsection>
 
233
    <refsection id="Computationalfunction_TOWS_c">
 
234
        <title>Computational function</title>
 
235
        <itemizedlist>
 
236
            <listitem>
 
237
                <para>SCI/modules/scicos_blocks/src/c/tows_c.c (Type 4)</para>
 
238
            </listitem>
 
239
        </itemizedlist>
 
240
    </refsection>
 
241
    <refsection id="Example_TOWS_c">
 
242
        <title>Example</title>
 
243
        <para>
 
244
            <link type="scilab" linkend="scilab.xcos/xcos/examples/sinks_pal/TOWS_c_Example.xcos">
 
245
                <inlinemediaobject>
 
246
                    <imageobject>
 
247
                        <imagedata align="center" fileref="../../../../examples/sinks_pal/TOWS_c_Example.png" valign="middle"/>
 
248
                    </imageobject>
 
249
                </inlinemediaobject>
 
250
            </link>
 
251
        </para>
 
252
    </refsection>
253
253
</refentry>