Xcos help: add notes about the use of scicos_simulate
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sinks_pal / END_c.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="END_c">
25     <refnamediv>
26         <refname>END_c</refname>
27         <refpurpose>END_c block</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata align="center" fileref="../../../../images/palettes/END_c.png" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_END_c">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="END_c">END_c block</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Description_END_c">Description</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Dialogbox_END_c">Dialog box</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Defaultproperties_END_c">Default
62                                 properties
63                             </xref>
64                         </para>
65                     </listitem>
66                     <listitem>
67                         <para>
68                             <xref linkend="Interfacingfunction_END_c">Interfacing
69                                 function
70                             </xref>
71                         </para>
72                     </listitem>
73                     <listitem>
74                         <para>
75                             <xref linkend="Computationalfunction_END_c">Computational
76                                 function
77                             </xref>
78                         </para>
79                     </listitem>
80                     <listitem>
81                         <para>
82                             <xref linkend="Seealso_END_c">See also</xref>
83                         </para>
84                     </listitem>
85                 </itemizedlist>
86             </listitem>
87         </itemizedlist>
88     </refsection>
89     <refsection id="Palette_END_c">
90         <title>Palette</title>
91         <itemizedlist>
92             <listitem>
93                 <para>
94                     <link linkend="Sinks_pal">Sinks - Sinks palette</link>
95                 </para>
96             </listitem>
97         </itemizedlist>
98     </refsection>
99     <refsection id="Description_END_c">
100         <title>Description</title>
101         <para>That block increases the current time to the final integration time
102             of the simulation when it is activated :
103         </para>
104         <latex>$$T_f = T_{cur}$$</latex>
105         <para>
106             with <emphasis role="bold">Tcur</emphasis> the activation date of
107             the block and <emphasis role="bold">Tf</emphasis> the final integration
108             time defined in the in the Setup item of the simulate Menu
109             (scs_m.props.tf).
110         </para>
111         <para>Note that the 'Final simulation time' item (on diagram settings) always end the simulation at the specified time. This block should be configured to end the simulation before this setting.
112         </para>
113     </refsection>
114     <refsection id="Dialogbox_END_c">
115         <title>Dialog box</title>
116         <para>
117             <inlinemediaobject>
118                 <imageobject>
119                     <imagedata align="center" fileref="../../../../images/gui/END_c_gui.gif" valign="middle"/>
120                 </imageobject>
121             </inlinemediaobject>
122         </para>
123         <para/>
124         <itemizedlist>
125             <listitem>
126                 <para>
127                     <emphasis role="bold">Final simulation time</emphasis>
128                 </para>
129                 <para>That parameter is a date for an initial output event. By using a
130                     feed back from the event output port to the event input port, then
131                     that block can himself end the simulation at the time defined by this
132                     parameter.
133                 </para>
134                 <para>Properties : Type 'vec' of size 1.</para>
135             </listitem>
136         </itemizedlist>
137     </refsection>
138     <refsection id="Defaultproperties_END_c">
139         <title>Default properties</title>
140         <itemizedlist>
141             <listitem>
142                 <para>
143                     <emphasis role="bold">always active:</emphasis> no
144                 </para>
145             </listitem>
146             <listitem>
147                 <para>
148                     <emphasis role="bold">direct-feedthrough:</emphasis> no
149                 </para>
150             </listitem>
151             <listitem>
152                 <para>
153                     <emphasis role="bold">zero-crossing:</emphasis> no
154                 </para>
155             </listitem>
156             <listitem>
157                 <para>
158                     <emphasis role="bold">mode:</emphasis> no
159                 </para>
160             </listitem>
161             <listitem>
162                 <para>
163                     <emphasis role="bold">number/sizes of activation
164                         inputs:
165                     </emphasis>
166                     1
167                 </para>
168             </listitem>
169             <listitem>
170                 <para>
171                     <emphasis role="bold">number/sizes of activation
172                         outputs:
173                     </emphasis>
174                     1
175                 </para>
176             </listitem>
177             <listitem>
178                 <para>
179                     <emphasis role="bold">continuous-time state:</emphasis>
180                     no
181                 </para>
182             </listitem>
183             <listitem>
184                 <para>
185                     <emphasis role="bold">discrete-time state:</emphasis> no
186                 </para>
187             </listitem>
188             <listitem>
189                 <para>
190                     <emphasis role="bold">object discrete-time state:</emphasis>
191                     no
192                 </para>
193             </listitem>
194             <listitem>
195                 <para>
196                     <emphasis role="bold">name of computational function:</emphasis>
197                     <emphasis role="italic">scicosexit</emphasis>
198                 </para>
199             </listitem>
200         </itemizedlist>
201     </refsection>
202     <refsection id="Interfacingfunction_END_c">
203         <title>Interfacing function</title>
204         <itemizedlist>
205             <listitem>
206                 <para>SCI/modules/scicos_blocks/macros/Events/END_c.sci</para>
207             </listitem>
208         </itemizedlist>
209     </refsection>
210     <refsection id="Computationalfunction_END_c">
211         <title>Computational function</title>
212         <itemizedlist>
213             <listitem>
214                 <para>SCI/modules/scicos_blocks/src/c/scicosexit.c (Type 4)</para>
215             </listitem>
216         </itemizedlist>
217     </refsection>
218     <refsection id="Example_END_c">
219         <title>End example</title>
220         <link type="scilab" linkend="scilab.xcos/xcos/examples/sinks_pal/END_c_Example.zcos">
221             <inlinemediaobject>
222                 <imageobject>
223                     <imagedata align="center" fileref="../../../../examples/sinks_pal/END_c_Example.zcos" valign="middle"/>
224                 </imageobject>
225             </inlinemediaobject>
226         </link>
227     </refsection>
228     <refsection id="Seealso_END_c">
229         <title>See also</title>
230         <itemizedlist>
231             <listitem>
232                 <para>
233                     <link linkend="ENDBLK">ENDBLK - END block (Scicos
234                         Block)
235                     </link>
236                 </para>
237             </listitem>
238         </itemizedlist>
239     </refsection>
240 </refentry>