Remove all the authors from the documentation. This has been done for the following...
[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., 675 Mass Ave, Cambridge, MA 02139, 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" version="5.0-subset Scilab" 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               <link linkend="ENDBLK">Compiled Super Block
81                 content
82               </link>
83             </para>
84           </listitem>
85           <listitem>
86             <para>
87               <xref linkend="Seealso_ENDBLK">See also</xref>
88             </para>
89           </listitem>
90         </itemizedlist>
91       </listitem>
92     </itemizedlist>
93   </refsection>
94   <refsection id="Palette_ENDBLK">
95     <title>Palette</title>
96     <itemizedlist>
97       <listitem>
98         <para>
99           <link linkend="Sinks_pal">Sinks - Sinks palette</link>
100         </para>
101       </listitem>
102     </itemizedlist>
103   </refsection>
104   <refsection id="Description_ENDBLK">
105     <title>Description</title>
106     <para>That block can be used to set the final time of the simulation. When
107       that block is truely parametrized then the simulator will jump to the
108       'final integration time' defined in the Setup item of the simulate Menu
109       from the time defined by the parameter 'Final simulation time' of the
110       dialog box. That parameter can be a numerical value or a symbolic variable
111       defined in the scicos context.
112     </para>
113   </refsection>
114   <refsection id="Dialogbox_ENDBLK">
115     <title>Dialog box</title>
116     <para>
117       <inlinemediaobject>
118         <imageobject>
119           <imagedata align="center" fileref="../../../images/ENDBLK_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>Set the final time of the simulation.</para>
130         <para>When simulator reaches that value then the current time will
131           jump to the final integration time.
132         </para>
133         <para>Properties : Type 'vec' of size 1.</para>
134       </listitem>
135     </itemizedlist>
136   </refsection>
137   <refsection id="Defaultproperties_ENDBLK">
138     <title>Default properties</title>
139     <itemizedlist>
140       <listitem>
141         <para>
142           <emphasis role="bold">always active:</emphasis> no
143         </para>
144       </listitem>
145       <listitem>
146         <para>
147           <emphasis role="bold">direct-feedthrough:</emphasis> no
148         </para>
149       </listitem>
150       <listitem>
151         <para>
152           <emphasis role="bold">zero-crossing:</emphasis> no
153         </para>
154       </listitem>
155       <listitem>
156         <para>
157           <emphasis role="bold">mode:</emphasis> no
158         </para>
159       </listitem>
160       <listitem>
161         <para>
162           <emphasis role="bold">number/sizes of activation
163             inputs:
164           </emphasis>
165           0
166         </para>
167       </listitem>
168       <listitem>
169         <para>
170           <emphasis role="bold">number/sizes of activation
171             outputs:
172           </emphasis>
173           0
174         </para>
175       </listitem>
176       <listitem>
177         <para>
178           <emphasis role="bold">continuous-time state:</emphasis>
179           no
180         </para>
181       </listitem>
182       <listitem>
183         <para>
184           <emphasis role="bold">discrete-time state:</emphasis> no
185         </para>
186       </listitem>
187       <listitem>
188         <para>
189           <emphasis role="bold">object discrete-time state:</emphasis>
190           no
191         </para>
192       </listitem>
193       <listitem>
194         <para>
195           <emphasis role="bold">name of computational function:</emphasis>
196           <emphasis role="italic">csuper</emphasis>
197         </para>
198       </listitem>
199     </itemizedlist>
200   </refsection>
201   <refsection id="Interfacingfunction_ENDBLK">
202     <title>Interfacing function</title>
203     <itemizedlist>
204       <listitem>
205         <para>SCI/modules/scicos_blocks/macros/Misc/ENDBLK.sci</para>
206       </listitem>
207     </itemizedlist>
208   </refsection>
209   <refsection id="CompiledSuperBlockcontent_ENDBLK">
210     <title>Compiled Super Block content</title>
211     <para>
212       <inlinemediaobject>
213         <imageobject>
214           <imagedata align="center" fileref="../../../images/ENDBLK_img3_eng.gif" valign="middle"/>
215         </imageobject>
216       </inlinemediaobject>
217     </para>
218   </refsection>
219   <refsection id="Seealso_ENDBLK">
220     <title>See also</title>
221     <itemizedlist>
222       <listitem>
223         <para>
224           <link linkend="END_c">END_c - END_c block (Scicos
225             Block)
226           </link>
227         </para>
228       </listitem>
229     </itemizedlist>
230   </refsection>
231 </refentry>