← 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/CLOCK_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/Sources_pal/CLOCK_c.xml
24
24
 * See the file ./license.txt
25
25
 -->
26
26
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="CLOCK_c" xml:lang="en_US">
27
 
  <refnamediv>
28
 
    <refname>CLOCK_c</refname>
29
 
    <refpurpose>Activation clock</refpurpose>
30
 
  </refnamediv>
31
 
  <refsection>
32
 
    <title>Block Screenshot</title>
33
 
    <para>
34
 
      <inlinemediaobject>
35
 
        <imageobject>
36
 
          <imagedata fileref="../../../../images/palettes/CLOCK_c.png" align="center" valign="middle"/>
37
 
        </imageobject>
38
 
      </inlinemediaobject>
39
 
    </para>
40
 
  </refsection>
41
 
  <refsection id="Contents_CLOCK_c">
42
 
    <title>Contents</title>
43
 
    <itemizedlist>
44
 
      <listitem>
45
 
        <para>
46
 
          <link linkend="CLOCK_c">Activation clock</link>
47
 
        </para>
48
 
      </listitem>
49
 
      <listitem>
50
 
        <itemizedlist>
51
 
          <listitem>
52
 
            <para>
53
 
              <xref linkend="Palette_CLOCK_c">Palette</xref>
54
 
            </para>
55
 
          </listitem>
56
 
          <listitem>
57
 
            <para>
58
 
              <xref linkend="Description_CLOCK_c">Description</xref>
59
 
            </para>
60
 
          </listitem>
61
 
          <listitem>
62
 
            <para>
63
 
              <xref linkend="Dialogbox_CLOCK_c">Dialog box</xref>
64
 
            </para>
65
 
          </listitem>
66
 
          <listitem>
67
 
            <para>
68
 
              <xref linkend="Defaultproperties_CLOCK_c">Default properties</xref>
69
 
            </para>
70
 
          </listitem>
71
 
          <listitem>
72
 
            <para>
73
 
              <link linkend="Example_CLOCK_c">Example</link>
74
 
            </para>
75
 
          </listitem>
76
 
          <listitem>
77
 
            <para>
78
 
              <xref linkend="Interfacingfunction_CLOCK_c">Interfacing function</xref>
79
 
            </para>
80
 
          </listitem>
81
 
          <listitem>
82
 
            <para>
83
 
              <xref linkend="Seealso_CLOCK_c">See also</xref>
84
 
            </para>
85
 
          </listitem>
86
 
        </itemizedlist>
87
 
      </listitem>
88
 
    </itemizedlist>
89
 
  </refsection>
90
 
  <refsection id="Palette_CLOCK_c">
91
 
    <title>Palette</title>
92
 
    <itemizedlist>
93
 
      <listitem>
94
 
        <para>
95
 
          <link linkend="Sources_pal">Sources palette</link>
96
 
        </para>
97
 
      </listitem>
98
 
    </itemizedlist>
99
 
  </refsection>
100
 
  <refsection id="Description_CLOCK_c">
101
 
    <title>Description</title>
102
 
    <para>
103
 
      The unique output of this block generates a regular train of events that are scheduled by
104
 
      parameter <emphasis role="bold">Period</emphasis> in seconds. The starting date of events
105
 
      generation can be set in seconds with the <emphasis role="bold">Initialisation Time</emphasis>
106
 
      parameter.
107
 
    </para>
108
 
  </refsection>
109
 
  <refsection id="Dialogbox_CLOCK_c">
110
 
    <title>Dialog box</title>
111
 
    <para>
112
 
      <inlinemediaobject>
113
 
        <imageobject>
114
 
          <imagedata fileref="../../../gui/sources_pal/en_US/CLOCK_c_gui.png" align="center"/>
115
 
        </imageobject>
116
 
      </inlinemediaobject>
117
 
    </para>
118
 
    <para/>
119
 
    <itemizedlist>
120
 
      <listitem>
121
 
        <para>
122
 
          <emphasis role="bold">Period</emphasis>
123
 
        </para>
124
 
        <para> Scalar.
125
 
          Period is the time that separates two output events, it is the
126
 
          inverse of the frequency of the clock.
127
 
        </para>
128
 
        <para> Properties : Type 'vec' of size 1. </para>
129
 
      </listitem>
130
 
      <listitem>
131
 
        <para>
132
 
          <emphasis role="bold">Initialisation Time</emphasis>
133
 
        </para>
134
 
        <para> Scalar. Starting date.</para>
135
 
        <para> If negative the clock never starts.</para>
136
 
        <para> Properties : Type 'vec' of size 1.</para>
137
 
      </listitem>
138
 
    </itemizedlist>
139
 
  </refsection>
140
 
  <refsection id="Defaultproperties_CLOCK_c">
141
 
    <title>Default properties</title>
142
 
    <itemizedlist>
143
 
      <listitem>
144
 
        <para>
145
 
          <emphasis role="bold">always active:</emphasis> no
146
 
        </para>
147
 
      </listitem>
148
 
      <listitem>
149
 
        <para>
150
 
          <emphasis role="bold">direct-feedthrough:</emphasis> no
151
 
        </para>
152
 
      </listitem>
153
 
      <listitem>
154
 
        <para>
155
 
          <emphasis role="bold">zero-crossing:</emphasis> no
156
 
        </para>
157
 
      </listitem>
158
 
      <listitem>
159
 
        <para>
160
 
          <emphasis role="bold">mode:</emphasis> no
161
 
        </para>
162
 
      </listitem>
163
 
      <listitem>
164
 
        <para>
165
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
166
 
        </para>
167
 
      </listitem>
168
 
      <listitem>
169
 
        <para>
170
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 1
171
 
        </para>
172
 
      </listitem>
173
 
      <listitem>
174
 
        <para>
175
 
          <emphasis role="bold">continuous-time state:</emphasis> no
176
 
        </para>
177
 
      </listitem>
178
 
      <listitem>
179
 
        <para>
180
 
          <emphasis role="bold">discrete-time state:</emphasis> no
181
 
        </para>
182
 
      </listitem>
183
 
      <listitem>
184
 
        <para>
185
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
186
 
        </para>
187
 
      </listitem>
188
 
      <listitem>
189
 
        <para>
190
 
          <emphasis role="bold">name of computational function:</emphasis>
191
 
          <emphasis role="italic">csuper</emphasis>
192
 
        </para>
193
 
      </listitem>
194
 
    </itemizedlist>
195
 
  </refsection>
196
 
  <refsection id="Example_CLOCK_c">
197
 
    <title>Example</title>
198
 
    <para>
199
 
      A simple example of CLOCK_c block event output.
200
 
      <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/clock_c_en_US.xcos">
201
 
        Open this example in Xcos
202
 
      </link>
203
 
      .
204
 
    </para>
205
 
    <para/>
206
 
    <mediaobject>
207
 
      <imageobject>
208
 
        <imagedata fileref="../../../examples/sources_pal/en_US/clock_c_diagram_en_US.png"/>
209
 
      </imageobject>
210
 
    </mediaobject>
211
 
  </refsection>
212
 
  <refsection id="Interfacingfunction_CLOCK_c">
213
 
    <title>Interfacing function</title>
214
 
    <itemizedlist>
215
 
      <listitem>
216
 
        <para>
217
 
          <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/CLOCK_c.sci">SCI/modules/scicos_blocks/macros/Sources/CLOCK_c.sci</link>
218
 
        </para>
219
 
      </listitem>
220
 
    </itemizedlist>
221
 
  </refsection>
222
 
  <refsection role="see also" id="Seealso_CLOCK_c">
223
 
    <title>See also</title>
224
 
    <itemizedlist>
225
 
      <listitem>
226
 
        <link linkend="SampleCLK">SampleCLK</link>
227
 
      </listitem>
228
 
    </itemizedlist>
229
 
  </refsection>
 
27
    <refnamediv>
 
28
        <refname>CLOCK_c</refname>
 
29
        <refpurpose>Activation clock</refpurpose>
 
30
    </refnamediv>
 
31
    <refsection>
 
32
        <title>Block Screenshot</title>
 
33
        <para>
 
34
            <inlinemediaobject>
 
35
                <imageobject>
 
36
                    <imagedata fileref="../../../../images/palettes/CLOCK_c.png" align="center" valign="middle"/>
 
37
                </imageobject>
 
38
            </inlinemediaobject>
 
39
        </para>
 
40
    </refsection>
 
41
    <refsection id="Contents_CLOCK_c">
 
42
        <title>Contents</title>
 
43
        <itemizedlist>
 
44
            <listitem>
 
45
                <para>
 
46
                    <link linkend="CLOCK_c">Activation clock</link>
 
47
                </para>
 
48
            </listitem>
 
49
            <listitem>
 
50
                <itemizedlist>
 
51
                    <listitem>
 
52
                        <para>
 
53
                            <xref linkend="Palette_CLOCK_c">Palette</xref>
 
54
                        </para>
 
55
                    </listitem>
 
56
                    <listitem>
 
57
                        <para>
 
58
                            <xref linkend="Description_CLOCK_c">Description</xref>
 
59
                        </para>
 
60
                    </listitem>
 
61
                    <listitem>
 
62
                        <para>
 
63
                            <xref linkend="Dialogbox_CLOCK_c">Dialog box</xref>
 
64
                        </para>
 
65
                    </listitem>
 
66
                    <listitem>
 
67
                        <para>
 
68
                            <xref linkend="Defaultproperties_CLOCK_c">Default properties</xref>
 
69
                        </para>
 
70
                    </listitem>
 
71
                    <listitem>
 
72
                        <para>
 
73
                            <link linkend="Example_CLOCK_c">Example</link>
 
74
                        </para>
 
75
                    </listitem>
 
76
                    <listitem>
 
77
                        <para>
 
78
                            <xref linkend="Interfacingfunction_CLOCK_c">Interfacing function</xref>
 
79
                        </para>
 
80
                    </listitem>
 
81
                    <listitem>
 
82
                        <para>
 
83
                            <xref linkend="Seealso_CLOCK_c">See also</xref>
 
84
                        </para>
 
85
                    </listitem>
 
86
                </itemizedlist>
 
87
            </listitem>
 
88
        </itemizedlist>
 
89
    </refsection>
 
90
    <refsection id="Palette_CLOCK_c">
 
91
        <title>Palette</title>
 
92
        <itemizedlist>
 
93
            <listitem>
 
94
                <para>
 
95
                    <link linkend="Sources_pal">Sources palette</link>
 
96
                </para>
 
97
            </listitem>
 
98
        </itemizedlist>
 
99
    </refsection>
 
100
    <refsection id="Description_CLOCK_c">
 
101
        <title>Description</title>
 
102
        <para>
 
103
            The unique output of this block generates a regular train of events that are scheduled by
 
104
            parameter <emphasis role="bold">Period</emphasis> in seconds. The starting date of events
 
105
            generation can be set in seconds with the <emphasis role="bold">Initialisation Time</emphasis>
 
106
            parameter.
 
107
        </para>
 
108
    </refsection>
 
109
    <refsection id="Dialogbox_CLOCK_c">
 
110
        <title>Dialog box</title>
 
111
        <para>
 
112
            <inlinemediaobject>
 
113
                <imageobject>
 
114
                    <imagedata fileref="../../../gui/sources_pal/en_US/CLOCK_c_gui.png" align="center"/>
 
115
                </imageobject>
 
116
            </inlinemediaobject>
 
117
        </para>
 
118
        <para/>
 
119
        <itemizedlist>
 
120
            <listitem>
 
121
                <para>
 
122
                    <emphasis role="bold">Period</emphasis>
 
123
                </para>
 
124
                <para> Scalar.
 
125
                    Period is the time that separates two output events, it is the
 
126
                    inverse of the frequency of the clock.
 
127
                </para>
 
128
                <para> Properties : Type 'vec' of size 1. </para>
 
129
            </listitem>
 
130
            <listitem>
 
131
                <para>
 
132
                    <emphasis role="bold">Initialisation Time</emphasis>
 
133
                </para>
 
134
                <para> Scalar. Starting date.</para>
 
135
                <para> If negative the clock never starts.</para>
 
136
                <para> Properties : Type 'vec' of size 1.</para>
 
137
            </listitem>
 
138
        </itemizedlist>
 
139
    </refsection>
 
140
    <refsection id="Defaultproperties_CLOCK_c">
 
141
        <title>Default properties</title>
 
142
        <itemizedlist>
 
143
            <listitem>
 
144
                <para>
 
145
                    <emphasis role="bold">always active:</emphasis> no
 
146
                </para>
 
147
            </listitem>
 
148
            <listitem>
 
149
                <para>
 
150
                    <emphasis role="bold">direct-feedthrough:</emphasis> no
 
151
                </para>
 
152
            </listitem>
 
153
            <listitem>
 
154
                <para>
 
155
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
156
                </para>
 
157
            </listitem>
 
158
            <listitem>
 
159
                <para>
 
160
                    <emphasis role="bold">mode:</emphasis> no
 
161
                </para>
 
162
            </listitem>
 
163
            <listitem>
 
164
                <para>
 
165
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
166
                </para>
 
167
            </listitem>
 
168
            <listitem>
 
169
                <para>
 
170
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 1
 
171
                </para>
 
172
            </listitem>
 
173
            <listitem>
 
174
                <para>
 
175
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
176
                </para>
 
177
            </listitem>
 
178
            <listitem>
 
179
                <para>
 
180
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
181
                </para>
 
182
            </listitem>
 
183
            <listitem>
 
184
                <para>
 
185
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
186
                </para>
 
187
            </listitem>
 
188
            <listitem>
 
189
                <para>
 
190
                    <emphasis role="bold">name of computational function:</emphasis>
 
191
                    <emphasis role="italic">csuper</emphasis>
 
192
                </para>
 
193
            </listitem>
 
194
        </itemizedlist>
 
195
    </refsection>
 
196
    <refsection id="Example_CLOCK_c">
 
197
        <title>Example</title>
 
198
        <para>
 
199
            A simple example of CLOCK_c block event output.
 
200
            <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/clock_c_en_US.xcos">
 
201
                Open this example in Xcos
 
202
            </link>
 
203
            .
 
204
        </para>
 
205
        <para/>
 
206
        <mediaobject>
 
207
            <imageobject>
 
208
                <imagedata fileref="../../../examples/sources_pal/en_US/clock_c_diagram_en_US.png"/>
 
209
            </imageobject>
 
210
        </mediaobject>
 
211
    </refsection>
 
212
    <refsection id="Interfacingfunction_CLOCK_c">
 
213
        <title>Interfacing function</title>
 
214
        <itemizedlist>
 
215
            <listitem>
 
216
                <para>
 
217
                    <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/CLOCK_c.sci">SCI/modules/scicos_blocks/macros/Sources/CLOCK_c.sci</link>
 
218
                </para>
 
219
            </listitem>
 
220
        </itemizedlist>
 
221
    </refsection>
 
222
    <refsection role="see also" id="Seealso_CLOCK_c">
 
223
        <title>See also</title>
 
224
        <itemizedlist>
 
225
            <listitem>
 
226
                <link linkend="SampleCLK">SampleCLK</link>
 
227
            </listitem>
 
228
        </itemizedlist>
 
229
    </refsection>
230
230
</refentry>