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 version="5.0-subset Scilab" xml:id="ENDBLK"
  25           xmlns="http://docbook.org/ns/docbook"
  26           xmlns:xlink="http://www.w3.org/1999/xlink"
  27           xmlns:svg="http://www.w3.org/2000/svg"
  28           xmlns:ns4="http://www.w3.org/1999/xhtml"
  29           xmlns:mml="http://www.w3.org/1998/Math/MathML"
  30           xmlns:db="http://docbook.org/ns/docbook">
  31   <refnamediv>
  32     <refname>ENDBLK</refname>
  33
  34     <refpurpose>END block</refpurpose>
  35   </refnamediv>
  36
  37   <refsection>
  38     <title>Block Screenshot</title>
  39
  40     <para><inlinemediaobject>
  41         <imageobject>
  42           <imagedata align="center"
  43                      fileref="../../../../images/palettes/ENDBLK.jpg"
  44                      valign="middle" />
  45         </imageobject>
  46       </inlinemediaobject></para>
  47   </refsection>
  48
  49   <refsection id="Contents_ENDBLK">
  50     <title>Contents</title>
  51
  52     <itemizedlist>
  53       <listitem>
  54         <para><link linkend="ENDBLK">END block</link></para>
  55       </listitem>
  56
  57       <listitem>
  58         <itemizedlist>
  59           <listitem>
  60             <para><xref linkend="Palette_ENDBLK">Palette</xref></para>
  61           </listitem>
  62
  63           <listitem>
  64             <para><xref linkend="Description_ENDBLK">Description</xref></para>
  65           </listitem>
  66
  67           <listitem>
  68             <para><xref linkend="Dialogbox_ENDBLK">Dialog box</xref></para>
  69           </listitem>
  70
  71           <listitem>
  72             <para><xref linkend="Defaultproperties_ENDBLK">Default
  73             properties</xref></para>
  74           </listitem>
  75
  76           <listitem>
  77             <para><xref linkend="Interfacingfunction_ENDBLK">Interfacing
  78             function</xref></para>
  79           </listitem>
  80
  81           <listitem>
  82             <para><link linkend="ENDBLK">Compiled Super Block
  83             content</link></para>
  84           </listitem>
  85
  86           <listitem>
  87             <para><xref linkend="Seealso_ENDBLK">See also</xref></para>
  88           </listitem>
  89
  90           <listitem>
  91             <para><xref linkend="Authors_ENDBLK">Authors</xref></para>
  92           </listitem>
  93         </itemizedlist>
  94       </listitem>
  95     </itemizedlist>
  96   </refsection>
  97
  98   <refsection id="Palette_ENDBLK">
  99     <title>Palette</title>
 100
 101     <itemizedlist>
 102       <listitem>
 103         <para><link linkend="Sinks_pal">Sinks - Sinks palette</link></para>
 104       </listitem>
 105     </itemizedlist>
 106   </refsection>
 107
 108   <refsection id="Description_ENDBLK">
 109     <title>Description</title>
 110
 111     <para>That block can be used to set the final time of the simulation. When
 112     that block is truely parametrized then the simulator will jump to the
 113     'final integration time' defined in the Setup item of the simulate Menu
 114     from the time defined by the parameter 'Final simulation time' of the
 115     dialog box. That parameter can be a numerical value or a symbolic variable
 116     defined in the scicos context.</para>
 117   </refsection>
 118
 119   <refsection id="Dialogbox_ENDBLK">
 120     <title>Dialog box</title>
 121
 122     <para><inlinemediaobject>
 123         <imageobject>
 124           <imagedata align="center" fileref="../../../images/ENDBLK_gui.gif"
 125                      valign="middle" />
 126         </imageobject>
 127       </inlinemediaobject></para>
 128
 129     <para></para>
 130
 131     <itemizedlist>
 132       <listitem>
 133         <para><emphasis role="bold">Final simulation time</emphasis></para>
 134
 135         <para>Set the final time of the simulation.</para>
 136
 137         <para>When simulator reaches that value then the current time will
 138         jump to the final integration time.</para>
 139
 140         <para>Properties : Type 'vec' of size 1.</para>
 141       </listitem>
 142     </itemizedlist>
 143   </refsection>
 144
 145   <refsection id="Defaultproperties_ENDBLK">
 146     <title>Default properties</title>
 147
 148     <itemizedlist>
 149       <listitem>
 150         <para><emphasis role="bold">always active:</emphasis> no</para>
 151       </listitem>
 152
 153       <listitem>
 154         <para><emphasis role="bold">direct-feedthrough:</emphasis> no</para>
 155       </listitem>
 156
 157       <listitem>
 158         <para><emphasis role="bold">zero-crossing:</emphasis> no</para>
 159       </listitem>
 160
 161       <listitem>
 162         <para><emphasis role="bold">mode:</emphasis> no</para>
 163       </listitem>
 164
 165       <listitem>
 166         <para><emphasis role="bold">number/sizes of activation
 167         inputs:</emphasis> 0</para>
 168       </listitem>
 169
 170       <listitem>
 171         <para><emphasis role="bold">number/sizes of activation
 172         outputs:</emphasis> 0</para>
 173       </listitem>
 174
 175       <listitem>
 176         <para><emphasis role="bold">continuous-time state:</emphasis>
 177         no</para>
 178       </listitem>
 179
 180       <listitem>
 181         <para><emphasis role="bold">discrete-time state:</emphasis> no</para>
 182       </listitem>
 183
 184       <listitem>
 185         <para><emphasis role="bold">object discrete-time state:</emphasis>
 186         no</para>
 187       </listitem>
 188
 189       <listitem>
 190         <para><emphasis role="bold">name of computational function:</emphasis>
 191         <emphasis role="italic">csuper</emphasis></para>
 192       </listitem>
 193     </itemizedlist>
 194   </refsection>
 195
 196   <refsection id="Interfacingfunction_ENDBLK">
 197     <title>Interfacing function</title>
 198
 199     <itemizedlist>
 200       <listitem>
 201         <para>SCI/modules/scicos_blocks/macros/Misc/ENDBLK.sci</para>
 202       </listitem>
 203     </itemizedlist>
 204   </refsection>
 205
 206   <refsection id="CompiledSuperBlockcontent_ENDBLK">
 207     <title>Compiled Super Block content</title>
 208
 209     <para><inlinemediaobject>
 210         <imageobject>
 211           <imagedata align="center"
 212                      fileref="../../../images/ENDBLK_img3_eng.gif"
 213                      valign="middle" />
 214         </imageobject>
 215       </inlinemediaobject></para>
 216   </refsection>
 217
 218   <refsection id="Seealso_ENDBLK">
 219     <title>See also</title>
 220
 221     <itemizedlist>
 222       <listitem>
 223         <para><link linkend="END_c">END_c - END_c block (Scicos
 224         Block)</link></para>
 225       </listitem>
 226     </itemizedlist>
 227   </refsection>
 228
 229   <refsection id="Authors_ENDBLK">
 230     <title>Authors</title>
 231
 232     <para><emphasis role="bold">Alan Layec</emphasis> - INRIA</para>
 233   </refsection>
 234 </refentry>