← 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/Sources_pal/Modulo_Count.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/Sources_pal/Modulo_Count.xml
23
23
 * See the file ./license.txt
24
24
 -->
25
25
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns5="http://www.w3.org/1999/xhtml" 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="Modulo_Count" xml:lang="en_US">
26
 
  <refnamediv>
27
 
    <refname>Modulo_Count</refname>
28
 
    <refpurpose>Modulo counter (0 to N counter)</refpurpose>
29
 
  </refnamediv>
30
 
  <refsection>
31
 
    <title>Block Screenshot</title>
32
 
    <para>
33
 
      <inlinemediaobject>
34
 
        <imageobject>
35
 
          <imagedata fileref="../../../../images/palettes/Modulo_Count.png" align="center" valign="middle"/>
36
 
        </imageobject>
37
 
      </inlinemediaobject>
38
 
    </para>
39
 
  </refsection>
40
 
  <refsection id="Contents_Modulo_Count">
41
 
    <title>Contents</title>
42
 
    <itemizedlist>
43
 
      <listitem>
44
 
        <para>
45
 
          <link linkend="Modulo_Count">Modulo counter (0 to N counter)</link>
46
 
        </para>
47
 
      </listitem>
48
 
      <listitem>
49
 
        <itemizedlist>
50
 
          <listitem>
51
 
            <para>
52
 
              <xref linkend="Palette_Modulo_Count">Palette</xref>
53
 
            </para>
54
 
          </listitem>
55
 
          <listitem>
56
 
            <para>
57
 
              <xref linkend="Description_Modulo_Count">Description</xref>
58
 
            </para>
59
 
          </listitem>
60
 
          <listitem>
61
 
            <para>
62
 
              <xref linkend="Datatype_Modulo_Count">Data types</xref>
63
 
            </para>
64
 
          </listitem>
65
 
          <listitem>
66
 
            <para>
67
 
              <xref linkend="Dialogbox_Modulo_Count">Dialog box</xref>
68
 
            </para>
69
 
          </listitem>
70
 
          <listitem>
71
 
            <para>
72
 
              <xref linkend="Defaultproperties_Modulo_Count">Default properties</xref>
73
 
            </para>
74
 
          </listitem>
75
 
          <listitem>
76
 
            <para>
77
 
              <xref linkend="Example_Modulo_Count">Example</xref>
78
 
            </para>
79
 
          </listitem>
80
 
          <listitem>
81
 
            <para>
82
 
              <xref linkend="Interfacingfunction_Modulo_Count">Interfacing function</xref>
83
 
            </para>
84
 
          </listitem>
85
 
          <listitem>
86
 
            <para>
87
 
              <xref linkend="Computationalfunction_Modulo_Count">Computational function</xref>
88
 
            </para>
89
 
          </listitem>
90
 
          <listitem>
91
 
            <para>
92
 
              <xref linkend="Seealso_Modulo_Count">See also</xref>
93
 
            </para>
94
 
          </listitem>
95
 
        </itemizedlist>
96
 
      </listitem>
97
 
    </itemizedlist>
98
 
  </refsection>
99
 
  <refsection id="Palette_Modulo_Count">
100
 
    <title>Palette</title>
101
 
    <itemizedlist>
102
 
      <listitem>
103
 
        <para>
104
 
          <link linkend="Sources_pal">Sources palette</link>
105
 
        </para>
106
 
      </listitem>
107
 
    </itemizedlist>
108
 
  </refsection>
109
 
  <refsection id="Description_Modulo_Count">
110
 
    <title>Description</title>
111
 
    <para>
112
 
      It is a discrete block. The block outputs a periodic scalar piecewise constant signal. Signal begin at <emphasis role="bold">Initial State</emphasis> value. The output is incremented when block received an event on its activation input until output reaches the <emphasis role="bold">Upper Limit</emphasis> parameter value. At this time the output is reset to 0. For a periodic event input, the output is a quantized sawtooth signal.
113
 
    </para>
114
 
  </refsection>
115
 
  <refsection id="Datatype_Modulo_Count">
116
 
    <title>Data type</title>
117
 
    <itemizedlist>
118
 
      <listitem>
119
 
        <para>
120
 
          Output: scalar double.
121
 
        </para>
122
 
      </listitem>
123
 
    </itemizedlist>
124
 
  </refsection>
125
 
  <refsection id="Dialogbox_Modulo_Count">
126
 
    <title>Dialog box</title>
127
 
    <para>
128
 
      <inlinemediaobject>
129
 
        <imageobject>
130
 
          <imagedata fileref="../../../gui/sources_pal/en_US/Modulo_Count_gui.png" align="center"/>
131
 
        </imageobject>
132
 
      </inlinemediaobject>
133
 
    </para>
134
 
    <para/>
135
 
    <itemizedlist>
136
 
      <listitem>
137
 
        <para>
138
 
          <emphasis role="bold">Initial State</emphasis>
139
 
        </para>
140
 
        <para> Scalar. Initial discrete state.</para>
141
 
        <para> Properties : Type 'vec' of size 1 </para>
142
 
      </listitem>
143
 
      <listitem>
144
 
        <para>
145
 
          <emphasis role="bold">Upper Limit (positive number)</emphasis>
146
 
        </para>
147
 
        <para> Scalar. Number of required step.</para>
148
 
        <para> Properties : Type 'vec' of size 1 </para>
149
 
      </listitem>
150
 
    </itemizedlist>
151
 
  </refsection>
152
 
  <refsection id="Defaultproperties_Modulo_Count">
153
 
    <title>Default properties</title>
154
 
    <itemizedlist>
155
 
      <listitem>
156
 
        <para>
157
 
          <emphasis role="bold">always active:</emphasis> no
158
 
        </para>
159
 
      </listitem>
160
 
      <listitem>
161
 
        <para>
162
 
          <emphasis role="bold">direct-feedthrough:</emphasis> no
163
 
        </para>
164
 
      </listitem>
165
 
      <listitem>
166
 
        <para>
167
 
          <emphasis role="bold">zero-crossing:</emphasis> no
168
 
        </para>
169
 
      </listitem>
170
 
      <listitem>
171
 
        <para>
172
 
          <emphasis role="bold">mode:</emphasis> no
173
 
        </para>
174
 
      </listitem>
175
 
      <listitem>
176
 
        <para>
177
 
          <emphasis role="bold">regular outputs:</emphasis>
178
 
        </para>
179
 
        <para>
180
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
181
 
        </para>
182
 
      </listitem>
183
 
      <listitem>
184
 
        <para>
185
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
186
 
        </para>
187
 
      </listitem>
188
 
      <listitem>
189
 
        <para>
190
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
191
 
        </para>
192
 
      </listitem>
193
 
      <listitem>
194
 
        <para>
195
 
          <emphasis role="bold">continuous-time state:</emphasis> no
196
 
        </para>
197
 
      </listitem>
198
 
      <listitem>
199
 
        <para>
200
 
          <emphasis role="bold">discrete-time state:</emphasis> yes
201
 
        </para>
202
 
      </listitem>
203
 
      <listitem>
204
 
        <para>
205
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
206
 
        </para>
207
 
      </listitem>
208
 
      <listitem>
209
 
        <para>
210
 
          <emphasis role="bold">name of computational function:</emphasis>
211
 
          <emphasis role="italic">modulo_count</emphasis>
212
 
        </para>
213
 
      </listitem>
214
 
    </itemizedlist>
215
 
  </refsection>
216
 
  <refsection id="Example_Modulo_Count">
217
 
    <title>Exemple</title>
218
 
    <para>
219
 
      This diagram shows the Modulo_count usage as a quantized sawtooth generator application.
220
 
      <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/modulo_count_en_US.xcos">
221
 
        Open this example in Xcos
222
 
      </link>
223
 
    </para>
224
 
    <mediaobject>
225
 
      <imageobject>
226
 
        <imagedata fileref="../../../examples/sources_pal/en_US/modulo_count_diagram_en_US.png" align="center"/>
227
 
      </imageobject>
228
 
    </mediaobject>
229
 
  </refsection>
230
 
  <refsection id="Interfacingfunction_Modulo_Count">
231
 
    <title>Interfacing function</title>
232
 
    <itemizedlist>
233
 
      <listitem>
234
 
        <para>
235
 
          <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/Modulo_Count.sci">SCI/modules/scicos_blocks/macros/Sources/Modulo_Count.sci</link>
236
 
        </para>
237
 
      </listitem>
238
 
    </itemizedlist>
239
 
  </refsection>
240
 
  <refsection id="Computationalfunction_Modulo_Count">
241
 
    <title>Computational function</title>
242
 
    <itemizedlist>
243
 
      <listitem>
244
 
        <para> SCI/modules/scicos_blocks/src/c/modulo_count.c (Type 4)</para>
245
 
      </listitem>
246
 
    </itemizedlist>
247
 
  </refsection>
248
 
  <refsection id="Seealso_Modulo_Count">
249
 
    <title>See also</title>
250
 
    <itemizedlist>
251
 
      <listitem>
252
 
        <link linkend="GENSQR_f">GENSQR_f</link>
253
 
      </listitem>
254
 
      <listitem>
255
 
        <link linkend="SAWTOOTH_f">SAWTOOTH_f</link>
256
 
      </listitem>
257
 
      <listitem>
258
 
        <link linkend="Sigbuilder">Sigbuilder</link>
259
 
      </listitem>
260
 
    </itemizedlist>
261
 
  </refsection>
 
26
    <refnamediv>
 
27
        <refname>Modulo_Count</refname>
 
28
        <refpurpose>Modulo counter (0 to N counter)</refpurpose>
 
29
    </refnamediv>
 
30
    <refsection>
 
31
        <title>Block Screenshot</title>
 
32
        <para>
 
33
            <inlinemediaobject>
 
34
                <imageobject>
 
35
                    <imagedata fileref="../../../../images/palettes/Modulo_Count.png" align="center" valign="middle"/>
 
36
                </imageobject>
 
37
            </inlinemediaobject>
 
38
        </para>
 
39
    </refsection>
 
40
    <refsection id="Contents_Modulo_Count">
 
41
        <title>Contents</title>
 
42
        <itemizedlist>
 
43
            <listitem>
 
44
                <para>
 
45
                    <link linkend="Modulo_Count">Modulo counter (0 to N counter)</link>
 
46
                </para>
 
47
            </listitem>
 
48
            <listitem>
 
49
                <itemizedlist>
 
50
                    <listitem>
 
51
                        <para>
 
52
                            <xref linkend="Palette_Modulo_Count">Palette</xref>
 
53
                        </para>
 
54
                    </listitem>
 
55
                    <listitem>
 
56
                        <para>
 
57
                            <xref linkend="Description_Modulo_Count">Description</xref>
 
58
                        </para>
 
59
                    </listitem>
 
60
                    <listitem>
 
61
                        <para>
 
62
                            <xref linkend="Datatype_Modulo_Count">Data types</xref>
 
63
                        </para>
 
64
                    </listitem>
 
65
                    <listitem>
 
66
                        <para>
 
67
                            <xref linkend="Dialogbox_Modulo_Count">Dialog box</xref>
 
68
                        </para>
 
69
                    </listitem>
 
70
                    <listitem>
 
71
                        <para>
 
72
                            <xref linkend="Defaultproperties_Modulo_Count">Default properties</xref>
 
73
                        </para>
 
74
                    </listitem>
 
75
                    <listitem>
 
76
                        <para>
 
77
                            <xref linkend="Example_Modulo_Count">Example</xref>
 
78
                        </para>
 
79
                    </listitem>
 
80
                    <listitem>
 
81
                        <para>
 
82
                            <xref linkend="Interfacingfunction_Modulo_Count">Interfacing function</xref>
 
83
                        </para>
 
84
                    </listitem>
 
85
                    <listitem>
 
86
                        <para>
 
87
                            <xref linkend="Computationalfunction_Modulo_Count">Computational function</xref>
 
88
                        </para>
 
89
                    </listitem>
 
90
                    <listitem>
 
91
                        <para>
 
92
                            <xref linkend="Seealso_Modulo_Count">See also</xref>
 
93
                        </para>
 
94
                    </listitem>
 
95
                </itemizedlist>
 
96
            </listitem>
 
97
        </itemizedlist>
 
98
    </refsection>
 
99
    <refsection id="Palette_Modulo_Count">
 
100
        <title>Palette</title>
 
101
        <itemizedlist>
 
102
            <listitem>
 
103
                <para>
 
104
                    <link linkend="Sources_pal">Sources palette</link>
 
105
                </para>
 
106
            </listitem>
 
107
        </itemizedlist>
 
108
    </refsection>
 
109
    <refsection id="Description_Modulo_Count">
 
110
        <title>Description</title>
 
111
        <para>
 
112
            It is a discrete block. The block outputs a periodic scalar piecewise constant signal. Signal begin at <emphasis role="bold">Initial State</emphasis> value. The output is incremented when block received an event on its activation input until output reaches the <emphasis role="bold">Upper Limit</emphasis> parameter value. At this time the output is reset to 0. For a periodic event input, the output is a quantized sawtooth signal.
 
113
        </para>
 
114
    </refsection>
 
115
    <refsection id="Datatype_Modulo_Count">
 
116
        <title>Data type</title>
 
117
        <itemizedlist>
 
118
            <listitem>
 
119
                <para>
 
120
                    Output: scalar double.
 
121
                </para>
 
122
            </listitem>
 
123
        </itemizedlist>
 
124
    </refsection>
 
125
    <refsection id="Dialogbox_Modulo_Count">
 
126
        <title>Dialog box</title>
 
127
        <para>
 
128
            <inlinemediaobject>
 
129
                <imageobject>
 
130
                    <imagedata fileref="../../../gui/sources_pal/en_US/Modulo_Count_gui.png" align="center"/>
 
131
                </imageobject>
 
132
            </inlinemediaobject>
 
133
        </para>
 
134
        <para/>
 
135
        <itemizedlist>
 
136
            <listitem>
 
137
                <para>
 
138
                    <emphasis role="bold">Initial State</emphasis>
 
139
                </para>
 
140
                <para> Scalar. Initial discrete state.</para>
 
141
                <para> Properties : Type 'vec' of size 1 </para>
 
142
            </listitem>
 
143
            <listitem>
 
144
                <para>
 
145
                    <emphasis role="bold">Upper Limit (positive number)</emphasis>
 
146
                </para>
 
147
                <para> Scalar. Number of required step.</para>
 
148
                <para> Properties : Type 'vec' of size 1 </para>
 
149
            </listitem>
 
150
        </itemizedlist>
 
151
    </refsection>
 
152
    <refsection id="Defaultproperties_Modulo_Count">
 
153
        <title>Default properties</title>
 
154
        <itemizedlist>
 
155
            <listitem>
 
156
                <para>
 
157
                    <emphasis role="bold">always active:</emphasis> no
 
158
                </para>
 
159
            </listitem>
 
160
            <listitem>
 
161
                <para>
 
162
                    <emphasis role="bold">direct-feedthrough:</emphasis> no
 
163
                </para>
 
164
            </listitem>
 
165
            <listitem>
 
166
                <para>
 
167
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
168
                </para>
 
169
            </listitem>
 
170
            <listitem>
 
171
                <para>
 
172
                    <emphasis role="bold">mode:</emphasis> no
 
173
                </para>
 
174
            </listitem>
 
175
            <listitem>
 
176
                <para>
 
177
                    <emphasis role="bold">regular outputs:</emphasis>
 
178
                </para>
 
179
                <para>
 
180
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
181
                </para>
 
182
            </listitem>
 
183
            <listitem>
 
184
                <para>
 
185
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
 
186
                </para>
 
187
            </listitem>
 
188
            <listitem>
 
189
                <para>
 
190
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
191
                </para>
 
192
            </listitem>
 
193
            <listitem>
 
194
                <para>
 
195
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
196
                </para>
 
197
            </listitem>
 
198
            <listitem>
 
199
                <para>
 
200
                    <emphasis role="bold">discrete-time state:</emphasis> yes
 
201
                </para>
 
202
            </listitem>
 
203
            <listitem>
 
204
                <para>
 
205
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
206
                </para>
 
207
            </listitem>
 
208
            <listitem>
 
209
                <para>
 
210
                    <emphasis role="bold">name of computational function:</emphasis>
 
211
                    <emphasis role="italic">modulo_count</emphasis>
 
212
                </para>
 
213
            </listitem>
 
214
        </itemizedlist>
 
215
    </refsection>
 
216
    <refsection id="Example_Modulo_Count">
 
217
        <title>Exemple</title>
 
218
        <para>
 
219
            This diagram shows the Modulo_count usage as a quantized sawtooth generator application.
 
220
            <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/modulo_count_en_US.xcos">
 
221
                Open this example in Xcos
 
222
            </link>
 
223
        </para>
 
224
        <mediaobject>
 
225
            <imageobject>
 
226
                <imagedata fileref="../../../examples/sources_pal/en_US/modulo_count_diagram_en_US.png" align="center"/>
 
227
            </imageobject>
 
228
        </mediaobject>
 
229
    </refsection>
 
230
    <refsection id="Interfacingfunction_Modulo_Count">
 
231
        <title>Interfacing function</title>
 
232
        <itemizedlist>
 
233
            <listitem>
 
234
                <para>
 
235
                    <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/Modulo_Count.sci">SCI/modules/scicos_blocks/macros/Sources/Modulo_Count.sci</link>
 
236
                </para>
 
237
            </listitem>
 
238
        </itemizedlist>
 
239
    </refsection>
 
240
    <refsection id="Computationalfunction_Modulo_Count">
 
241
        <title>Computational function</title>
 
242
        <itemizedlist>
 
243
            <listitem>
 
244
                <para> SCI/modules/scicos_blocks/src/c/modulo_count.c (Type 4)</para>
 
245
            </listitem>
 
246
        </itemizedlist>
 
247
    </refsection>
 
248
    <refsection id="Seealso_Modulo_Count">
 
249
        <title>See also</title>
 
250
        <itemizedlist>
 
251
            <listitem>
 
252
                <link linkend="GENSQR_f">GENSQR_f</link>
 
253
            </listitem>
 
254
            <listitem>
 
255
                <link linkend="SAWTOOTH_f">SAWTOOTH_f</link>
 
256
            </listitem>
 
257
            <listitem>
 
258
                <link linkend="Sigbuilder">Sigbuilder</link>
 
259
            </listitem>
 
260
        </itemizedlist>
 
261
    </refsection>
262
262
</refentry>