← 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/CFSCOPE.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/CFSCOPE.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="CFSCOPE">
25
 
  <refnamediv>
26
 
    <refname>CFSCOPE</refname>
27
 
    <refpurpose>Floating point scope</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/CFSCOPE.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_CFSCOPE">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="CFSCOPE">Floating point scope</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_CFSCOPE">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_CFSCOPE">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_CFSCOPE">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_CFSCOPE">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_CFSCOPE">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_CFSCOPE">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
        </itemizedlist>
80
 
      </listitem>
81
 
    </itemizedlist>
82
 
  </refsection>
83
 
  <refsection id="Palette_CFSCOPE">
84
 
    <title>Palette</title>
85
 
    <itemizedlist>
86
 
      <listitem>
87
 
        <para>
88
 
          <link linkend="Sinks_pal">Sinks palette</link>
89
 
        </para>
90
 
      </listitem>
91
 
    </itemizedlist>
92
 
  </refsection>
93
 
  <refsection id="Description_CFSCOPE">
94
 
    <title>Description</title>
95
 
    <para>
96
 
      This is a floating scope block.  
97
 
    </para>
98
 
    <para>
99
 
    </para>
100
 
  </refsection>
101
 
  <refsection id="Dialogbox_CFSCOPE">
102
 
    <title>Dialog box</title>
103
 
    <para>
104
 
      <inlinemediaobject>
105
 
        <imageobject>
106
 
          <imagedata fileref="../../../../images/gui/CFSCOPE_gui.gif" align="center" valign="middle"/>
107
 
        </imageobject>
108
 
      </inlinemediaobject>
109
 
    </para>
110
 
    <para>
111
 
      
112
 
    </para>
113
 
    <itemizedlist>
114
 
      <listitem>
115
 
        <para>
116
 
          <emphasis role="bold">Color </emphasis>
117
 
        </para>
118
 
        <para>
119
 
          a vector of integers. The i-th element is the color number (
120
 
          <inlinemediaobject>
121
 
            <imageobject>
122
 
              <imagedata fileref="../../../../help/images/CFSCOPE_img3_eng.gif" align="center" valign="middle"/>
123
 
            </imageobject>
124
 
          </inlinemediaobject>
125
 
          ) or dash type (
126
 
          <inlinemediaobject>
127
 
            <imageobject>
128
 
              <imagedata fileref="../../../../help/images/CFSCOPE_img4_eng.gif" align="center" valign="middle"/>
129
 
            </imageobject>
130
 
          </inlinemediaobject>
131
 
          ) used to draw the evolution of the i-th input port signal. See<emphasis role="bold">plot2d</emphasis> for color (dash type) definitions.
132
 
        </para>
133
 
        <para> Properties : Type 'vec' of size 8 </para>
134
 
      </listitem>
135
 
      <listitem>
136
 
        <para>
137
 
          <emphasis role="bold">Output window number </emphasis>
138
 
        </para>
139
 
        <para>
140
 
          The number of graphic window used for the display. It is often good to use high values to avoid conflict with palettes and Super Block windows. If default value is used<emphasis role="bold">(1)</emphasis> , Xcos define the output window number.
141
 
        </para>
142
 
        <para> Properties : Type 'vec' of size 1 </para>
143
 
      </listitem>
144
 
      <listitem>
145
 
        <para>
146
 
          <emphasis role="bold">Output window position</emphasis>
147
 
        </para>
148
 
        <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
149
 
        <para> Properties : Type 'vec' of size -1 </para>
150
 
      </listitem>
151
 
      <listitem>
152
 
        <para>
153
 
          <emphasis role="bold">Output window sizes</emphasis>
154
 
        </para>
155
 
        <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
156
 
        <para> Properties : Type 'vec' of size -1 </para>
157
 
      </listitem>
158
 
      <listitem>
159
 
        <para>
160
 
          <emphasis role="bold">Ymin</emphasis>
161
 
        </para>
162
 
        <para> Minimum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
163
 
        <para> Properties : Type 'vec' of size -1 </para>
164
 
      </listitem>
165
 
      <listitem>
166
 
        <para>
167
 
          <emphasis role="bold">Ymax</emphasis>
168
 
        </para>
169
 
        <para> Maximum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
170
 
        <para> Properties : Type 'vec' of size 1 </para>
171
 
      </listitem>
172
 
      <listitem>
173
 
        <para>
174
 
          <emphasis role="bold">Refresh period</emphasis>
175
 
        </para>
176
 
        <para> Maximum value on the X-axis (time). The plot is redrawn when time reaches a multiple of this value.</para>
177
 
        <para> Properties : Type 'vec' of size </para>
178
 
      </listitem>
179
 
      <listitem>
180
 
        <para>
181
 
          <emphasis role="bold">Buffer size</emphasis>
182
 
        </para>
183
 
        <para>
184
 
          To improve efficiency it is possible to buffer the input data. The drawing is only done after each<emphasis role="bold">Buffer size</emphasis> call to the block.
185
 
        </para>
186
 
        <para> Properties : Type 'vec' of size 1 </para>
187
 
      </listitem>
188
 
      <listitem>
189
 
        <para>
190
 
          <emphasis role="bold">Links to view</emphasis>
191
 
        </para>
192
 
        <para> This parameter allows you to display the output of specified link.</para>
193
 
        <para> Properties : Type 'vec' of size 1</para>
194
 
      </listitem>
195
 
    </itemizedlist>
196
 
  </refsection>
197
 
  <refsection id="Defaultproperties_CFSCOPE">
198
 
    <title>Default properties</title>
199
 
    <itemizedlist>
200
 
      <listitem>
201
 
        <para>
202
 
          <emphasis role="bold">always active:</emphasis> no
203
 
        </para>
204
 
      </listitem>
205
 
      <listitem>
206
 
        <para>
207
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
208
 
        </para>
209
 
      </listitem>
210
 
      <listitem>
211
 
        <para>
212
 
          <emphasis role="bold">zero-crossing:</emphasis> no
213
 
        </para>
214
 
      </listitem>
215
 
      <listitem>
216
 
        <para>
217
 
          <emphasis role="bold">mode:</emphasis> no
218
 
        </para>
219
 
      </listitem>
220
 
      <listitem>
221
 
        <para>
222
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
223
 
        </para>
224
 
      </listitem>
225
 
      <listitem>
226
 
        <para>
227
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
228
 
        </para>
229
 
      </listitem>
230
 
      <listitem>
231
 
        <para>
232
 
          <emphasis role="bold">continuous-time state:</emphasis> no
233
 
        </para>
234
 
      </listitem>
235
 
      <listitem>
236
 
        <para>
237
 
          <emphasis role="bold">discrete-time state:</emphasis> no
238
 
        </para>
239
 
      </listitem>
240
 
      <listitem>
241
 
        <para>
242
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
243
 
        </para>
244
 
      </listitem>
245
 
      <listitem>
246
 
        <para>
247
 
          <emphasis role="bold">name of computational function:</emphasis>
248
 
          <emphasis role="italic">cfscope</emphasis>
249
 
        </para>
250
 
      </listitem>
251
 
    </itemizedlist>
252
 
  </refsection>
253
 
  <refsection id="Interfacingfunction_CFSCOPE">
254
 
    <title>Interfacing function</title>
255
 
    <itemizedlist>
256
 
      <listitem>
257
 
        <para> SCI/modules/scicos_blocks/macros/Sinks/CFSCOPE.sci</para>
258
 
      </listitem>
259
 
    </itemizedlist>
260
 
  </refsection>
261
 
  <refsection id="Computationalfunction_CFSCOPE">
262
 
    <title>Computational function</title>
263
 
    <itemizedlist>
264
 
      <listitem>
265
 
        <para> SCI/modules/scicos_blocks/src/c/cfscope.c (Type 4)</para>
266
 
      </listitem>
267
 
    </itemizedlist>
268
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>CFSCOPE</refname>
 
27
        <refpurpose>Floating point scope</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/CFSCOPE.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_CFSCOPE">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="CFSCOPE">Floating point scope</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_CFSCOPE">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_CFSCOPE">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_CFSCOPE">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_CFSCOPE">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_CFSCOPE">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_CFSCOPE">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                </itemizedlist>
 
80
            </listitem>
 
81
        </itemizedlist>
 
82
    </refsection>
 
83
    <refsection id="Palette_CFSCOPE">
 
84
        <title>Palette</title>
 
85
        <itemizedlist>
 
86
            <listitem>
 
87
                <para>
 
88
                    <link linkend="Sinks_pal">Sinks palette</link>
 
89
                </para>
 
90
            </listitem>
 
91
        </itemizedlist>
 
92
    </refsection>
 
93
    <refsection id="Description_CFSCOPE">
 
94
        <title>Description</title>
 
95
        <para>
 
96
            This is a floating scope block.  
 
97
        </para>
 
98
        <para>
 
99
        </para>
 
100
    </refsection>
 
101
    <refsection id="Dialogbox_CFSCOPE">
 
102
        <title>Dialog box</title>
 
103
        <para>
 
104
            <inlinemediaobject>
 
105
                <imageobject>
 
106
                    <imagedata fileref="../../../../images/gui/CFSCOPE_gui.gif" align="center" valign="middle"/>
 
107
                </imageobject>
 
108
            </inlinemediaobject>
 
109
        </para>
 
110
        <para>
 
111
            
 
112
        </para>
 
113
        <itemizedlist>
 
114
            <listitem>
 
115
                <para>
 
116
                    <emphasis role="bold">Color </emphasis>
 
117
                </para>
 
118
                <para>
 
119
                    a vector of integers. The i-th element is the color number (
 
120
                    <inlinemediaobject>
 
121
                        <imageobject>
 
122
                            <imagedata fileref="../../../../help/images/CFSCOPE_img3_eng.gif" align="center" valign="middle"/>
 
123
                        </imageobject>
 
124
                    </inlinemediaobject>
 
125
                    ) or dash type (
 
126
                    <inlinemediaobject>
 
127
                        <imageobject>
 
128
                            <imagedata fileref="../../../../help/images/CFSCOPE_img4_eng.gif" align="center" valign="middle"/>
 
129
                        </imageobject>
 
130
                    </inlinemediaobject>
 
131
                    ) used to draw the evolution of the i-th input port signal. See<emphasis role="bold">plot2d</emphasis> for color (dash type) definitions.
 
132
                </para>
 
133
                <para> Properties : Type 'vec' of size 8 </para>
 
134
            </listitem>
 
135
            <listitem>
 
136
                <para>
 
137
                    <emphasis role="bold">Output window number </emphasis>
 
138
                </para>
 
139
                <para>
 
140
                    The number of graphic window used for the display. It is often good to use high values to avoid conflict with palettes and Super Block windows. If default value is used<emphasis role="bold">(1)</emphasis> , Xcos define the output window number.
 
141
                </para>
 
142
                <para> Properties : Type 'vec' of size 1 </para>
 
143
            </listitem>
 
144
            <listitem>
 
145
                <para>
 
146
                    <emphasis role="bold">Output window position</emphasis>
 
147
                </para>
 
148
                <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
 
149
                <para> Properties : Type 'vec' of size -1 </para>
 
150
            </listitem>
 
151
            <listitem>
 
152
                <para>
 
153
                    <emphasis role="bold">Output window sizes</emphasis>
 
154
                </para>
 
155
                <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
 
156
                <para> Properties : Type 'vec' of size -1 </para>
 
157
            </listitem>
 
158
            <listitem>
 
159
                <para>
 
160
                    <emphasis role="bold">Ymin</emphasis>
 
161
                </para>
 
162
                <para> Minimum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
 
163
                <para> Properties : Type 'vec' of size -1 </para>
 
164
            </listitem>
 
165
            <listitem>
 
166
                <para>
 
167
                    <emphasis role="bold">Ymax</emphasis>
 
168
                </para>
 
169
                <para> Maximum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
 
170
                <para> Properties : Type 'vec' of size 1 </para>
 
171
            </listitem>
 
172
            <listitem>
 
173
                <para>
 
174
                    <emphasis role="bold">Refresh period</emphasis>
 
175
                </para>
 
176
                <para> Maximum value on the X-axis (time). The plot is redrawn when time reaches a multiple of this value.</para>
 
177
                <para> Properties : Type 'vec' of size </para>
 
178
            </listitem>
 
179
            <listitem>
 
180
                <para>
 
181
                    <emphasis role="bold">Buffer size</emphasis>
 
182
                </para>
 
183
                <para>
 
184
                    To improve efficiency it is possible to buffer the input data. The drawing is only done after each<emphasis role="bold">Buffer size</emphasis> call to the block.
 
185
                </para>
 
186
                <para> Properties : Type 'vec' of size 1 </para>
 
187
            </listitem>
 
188
            <listitem>
 
189
                <para>
 
190
                    <emphasis role="bold">Links to view</emphasis>
 
191
                </para>
 
192
                <para> This parameter allows you to display the output of specified link.</para>
 
193
                <para> Properties : Type 'vec' of size 1</para>
 
194
            </listitem>
 
195
        </itemizedlist>
 
196
    </refsection>
 
197
    <refsection id="Defaultproperties_CFSCOPE">
 
198
        <title>Default properties</title>
 
199
        <itemizedlist>
 
200
            <listitem>
 
201
                <para>
 
202
                    <emphasis role="bold">always active:</emphasis> no
 
203
                </para>
 
204
            </listitem>
 
205
            <listitem>
 
206
                <para>
 
207
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
208
                </para>
 
209
            </listitem>
 
210
            <listitem>
 
211
                <para>
 
212
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
213
                </para>
 
214
            </listitem>
 
215
            <listitem>
 
216
                <para>
 
217
                    <emphasis role="bold">mode:</emphasis> no
 
218
                </para>
 
219
            </listitem>
 
220
            <listitem>
 
221
                <para>
 
222
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
 
223
                </para>
 
224
            </listitem>
 
225
            <listitem>
 
226
                <para>
 
227
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
228
                </para>
 
229
            </listitem>
 
230
            <listitem>
 
231
                <para>
 
232
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
233
                </para>
 
234
            </listitem>
 
235
            <listitem>
 
236
                <para>
 
237
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
238
                </para>
 
239
            </listitem>
 
240
            <listitem>
 
241
                <para>
 
242
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
243
                </para>
 
244
            </listitem>
 
245
            <listitem>
 
246
                <para>
 
247
                    <emphasis role="bold">name of computational function:</emphasis>
 
248
                    <emphasis role="italic">cfscope</emphasis>
 
249
                </para>
 
250
            </listitem>
 
251
        </itemizedlist>
 
252
    </refsection>
 
253
    <refsection id="Interfacingfunction_CFSCOPE">
 
254
        <title>Interfacing function</title>
 
255
        <itemizedlist>
 
256
            <listitem>
 
257
                <para> SCI/modules/scicos_blocks/macros/Sinks/CFSCOPE.sci</para>
 
258
            </listitem>
 
259
        </itemizedlist>
 
260
    </refsection>
 
261
    <refsection id="Computationalfunction_CFSCOPE">
 
262
        <title>Computational function</title>
 
263
        <itemizedlist>
 
264
            <listitem>
 
265
                <para> SCI/modules/scicos_blocks/src/c/cfscope.c (Type 4)</para>
 
266
            </listitem>
 
267
        </itemizedlist>
 
268
    </refsection>
269
269
</refentry>