Xcos help: Sinks palette examples
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sinks_pal / ENDBLK.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  *
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * See the file ./license.txt
23  -->
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:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="ENDBLK">
25     <refnamediv>
26         <refname>ENDBLK</refname>
27         <refpurpose>END block</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata align="center" fileref="../../../../images/palettes/ENDBLK.png" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_ENDBLK">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="ENDBLK">END block</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_ENDBLK">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Description_ENDBLK">Description</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Dialogbox_ENDBLK">Dialog box</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Defaultproperties_ENDBLK">Default
67                                 properties
68                             </xref>
69                         </para>
70                     </listitem>
71                     <listitem>
72                         <para>
73                             <xref linkend="Interfacingfunction_ENDBLK">Interfacing
74                                 function
75                             </xref>
76                         </para>
77                     </listitem>
78                     <listitem>
79                         <para>
80                             <xref linkend="Seealso_ENDBLK">See also</xref>
81                         </para>
82                     </listitem>
83                 </itemizedlist>
84             </listitem>
85         </itemizedlist>
86     </refsection>
87     <refsection id="Palette_ENDBLK">
88         <title>Palette</title>
89         <itemizedlist>
90             <listitem>
91                 <para>
92                     <link linkend="Sinks_pal">Sinks - Sinks palette</link>
93                 </para>
94             </listitem>
95         </itemizedlist>
96     </refsection>
97     <refsection id="Description_ENDBLK">
98         <title>Description</title>
99         <para>That block can be used to set the final time of the simulation. When
100             that block is truely parametrized then the simulator will jump to the
101             'final integration time' defined in the Setup item of the simulate Menu
102             from the time defined by the parameter 'Final simulation time' of the
103             dialog box. That parameter can be a numerical value or a symbolic variable
104             defined in the scicos context.
105         </para>
106     </refsection>
107     <refsection id="Dialogbox_ENDBLK">
108         <title>Dialog box</title>
109         <para>
110             <inlinemediaobject>
111                 <imageobject>
112                     <imagedata align="center" fileref="../../../../images/gui/ENDBLK_gui.gif" valign="middle"/>
113                 </imageobject>
114             </inlinemediaobject>
115         </para>
116         <para/>
117         <itemizedlist>
118             <listitem>
119                 <para>
120                     <emphasis role="bold">Final simulation time</emphasis>
121                 </para>
122                 <para>Set the final time of the simulation.</para>
123                 <para>When simulator reaches that value then the current time will
124                     jump to the final integration time.
125                 </para>
126                 <para>Properties : Type 'vec' of size 1.</para>
127             </listitem>
128         </itemizedlist>
129     </refsection>
130     <refsection id="Defaultproperties_ENDBLK">
131         <title>Default properties</title>
132         <itemizedlist>
133             <listitem>
134                 <para>
135                     <emphasis role="bold">always active:</emphasis> no
136                 </para>
137             </listitem>
138             <listitem>
139                 <para>
140                     <emphasis role="bold">direct-feedthrough:</emphasis> no
141                 </para>
142             </listitem>
143             <listitem>
144                 <para>
145                     <emphasis role="bold">zero-crossing:</emphasis> no
146                 </para>
147             </listitem>
148             <listitem>
149                 <para>
150                     <emphasis role="bold">mode:</emphasis> no
151                 </para>
152             </listitem>
153             <listitem>
154                 <para>
155                     <emphasis role="bold">number/sizes of activation
156                         inputs:
157                     </emphasis>
158                     0
159                 </para>
160             </listitem>
161             <listitem>
162                 <para>
163                     <emphasis role="bold">number/sizes of activation
164                         outputs:
165                     </emphasis>
166                     0
167                 </para>
168             </listitem>
169             <listitem>
170                 <para>
171                     <emphasis role="bold">continuous-time state:</emphasis>
172                     no
173                 </para>
174             </listitem>
175             <listitem>
176                 <para>
177                     <emphasis role="bold">discrete-time state:</emphasis> no
178                 </para>
179             </listitem>
180             <listitem>
181                 <para>
182                     <emphasis role="bold">object discrete-time state:</emphasis>
183                     no
184                 </para>
185             </listitem>
186             <listitem>
187                 <para>
188                     <emphasis role="bold">name of computational function:</emphasis>
189                     <emphasis role="italic">csuper</emphasis>
190                 </para>
191             </listitem>
192         </itemizedlist>
193     </refsection>
194     <refsection id="Interfacingfunction_ENDBLK">
195         <title>Interfacing function</title>
196         <itemizedlist>
197             <listitem>
198                 <para>SCI/modules/scicos_blocks/macros/Misc/ENDBLK.sci</para>
199             </listitem>
200         </itemizedlist>
201     </refsection>
202     <refsection id="Example_ENDBLK">
203         <title>End example</title>
204         <link type="scilab" linkend="scilab.xcos/xcos/examples/sinks_pal/ENDBLK_Example.zcos">
205             <inlinemediaobject>
206                 <imageobject>
207                     <imagedata align="center" fileref="../../../../examples/sinks_pal/ENDBLK_Example.zcos" valign="middle"/>
208                 </imageobject>
209             </inlinemediaobject>
210         </link>
211     </refsection>
212     <refsection id="Seealso_ENDBLK">
213         <title>See also</title>
214         <itemizedlist>
215             <listitem>
216                 <para>
217                     <link linkend="END_c">END_c - END_c block (Scicos
218                         Block)
219                     </link>
220                 </para>
221             </listitem>
222         </itemizedlist>
223     </refsection>
224 </refentry>