scilab/modules/xcos/help/en_US/palettes/Sources_pal/Counter.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Xcos
   4  *
   5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
   6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
   7  * Copyright (C) 2011 - Bernard DUJARDIN <bernard.dujardin@contrib.scilab.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  *
  23  * See the file ./license.txt
  24  -->
  25 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="Counter" xml:lang="en_US">
  26     <refnamediv>
  27         <refname>Counter</refname>
  28         <refpurpose>Counter</refpurpose>
  29     </refnamediv>
  30     <refsection>
  31         <title>Block Screenshot</title>
  32         <para>
  33             <inlinemediaobject>
  34                 <imageobject>
  35                     <imagedata fileref="../../../../images/palettes/Counter.png" align="center" valign="middle"/>
  36                 </imageobject>
  37             </inlinemediaobject>
  38         </para>
  39     </refsection>
  40     <refsection id="Contents_Counter">
  41         <title>Contents</title>
  42         <itemizedlist>
  43             <listitem>
  44                 <para>
  45                     <link linkend="Counter">Counter</link>
  46                 </para>
  47             </listitem>
  48             <listitem>
  49                 <itemizedlist>
  50                     <listitem>
  51                         <para>
  52                             <xref linkend="Palette_Counter">Palette</xref>
  53                         </para>
  54                     </listitem>
  55                     <listitem>
  56                         <para>
  57                             <xref linkend="Description_Counter">Description</xref>
  58                         </para>
  59                     </listitem>
  60                     <listitem>
  61                         <para>
  62                             <xref linkend="Datatypes_Counter">Data types</xref>
  63                         </para>
  64                     </listitem>
  65                     <listitem>
  66                         <para>
  67                             <xref linkend="Dialogbox_Counter">Dialog box</xref>
  68                         </para>
  69                     </listitem>
  70                     <listitem>
  71                         <para>
  72                             <xref linkend="Defaultproperties_Counter">Default properties</xref>
  73                         </para>
  74                     </listitem>
  75                     <listitem>
  76                         <para>
  77                             <xref linkend="Example_Counter">Example</xref>
  78                         </para>
  79                     </listitem>
  80                     <listitem>
  81                         <para>
  82                             <xref linkend="Interfacingfunction_Counter">Interfacing function</xref>
  83                         </para>
  84                     </listitem>
  85                     <listitem>
  86                         <para>
  87                             <xref linkend="Computationalfunction_Counter">Computational function</xref>
  88                         </para>
  89                     </listitem>
  90                     <listitem>
  91                         <para>
  92                             <xref linkend="Seealso_Counter">See also</xref>
  93                         </para>
  94                     </listitem>
  95                 </itemizedlist>
  96             </listitem>
  97         </itemizedlist>
  98     </refsection>
  99     <refsection id="Palette_Counter">
 100         <title>Palette</title>
 101         <itemizedlist>
 102             <listitem>
 103                 <para>
 104                     <link linkend="Sources_pal">Sources palette</link>
 105                 </para>
 106             </listitem>
 107         </itemizedlist>
 108     </refsection>
 109     <refsection id="Description_Counter">
 110         <title>Description</title>
 111         <para>
 112             This block counts with an increment/decrement value equal to one from <emphasis role="bold">Minimum</emphasis> to <emphasis role="bold">Maximum</emphasis>
 113             or from <emphasis role="bold">Maximum</emphasis> to <emphasis role="bold">Minimum</emphasis> depending
 114             on the choice of the <emphasis role="bold">Rule</emphasis> parameter.
 115         </para>
 116     </refsection>
 117     <refsection id="Datatypes_Counter">
 118         <title>Data types</title>
 119         <itemizedlist>
 120             <listitem>
 121                 <para>
 122                     Output: scalar double.
 123                 </para>
 124             </listitem>
 125         </itemizedlist>
 126     </refsection>
 127     <refsection id="Dialogbox_Counter">
 128         <title>Dialog box</title>
 129         <para>
 130             <inlinemediaobject>
 131                 <imageobject>
 132                     <imagedata fileref="../../../gui/sources_pal/en_US/Counter_gui.png" align="center"/>
 133                 </imageobject>
 134             </inlinemediaobject>
 135         </para>
 136         <para/>
 137         <itemizedlist>
 138             <listitem>
 139                 <para>
 140                     <emphasis role="bold">Minimum</emphasis>
 141                 </para>
 142                 <para> The lowest number of the counter.</para>
 143                 <para> Properties : Type 'vec' of size 1. </para>
 144             </listitem>
 145             <listitem>
 146                 <para>
 147                     <emphasis role="bold">Maximum</emphasis>
 148                 </para>
 149                 <para> The highest number of the counter.</para>
 150                 <para> Properties : Type 'vec' of size 1. </para>
 151             </listitem>
 152             <listitem>
 153                 <para>
 154                     <emphasis role="bold">Rule (1:Increment, 2:Decrement)</emphasis>
 155                 </para>
 156                 <para> The rule of counting :</para>
 157                 <itemizedlist>
 158                     <listitem>
 159                         <para>
 160                             <emphasis role="bold">1</emphasis>: Counts from the lowest number to the highest number. The count is increasing.
 161                         </para>
 162                     </listitem>
 163                     <listitem>
 164                         <para>
 165                             <emphasis role="bold">2</emphasis>: Counts from the highest number to the lowest number. The count is decreasing.
 166                         </para>
 167                     </listitem>
 168                 </itemizedlist>
 169                 <para> Properties : Type 'vec' of size 1.</para>
 170             </listitem>
 171         </itemizedlist>
 172     </refsection>
 173     <refsection id="Defaultproperties_Counter">
 174         <title>Default properties</title>
 175         <itemizedlist>
 176             <listitem>
 177                 <para>
 178                     <emphasis role="bold">always active:</emphasis> no
 179                 </para>
 180             </listitem>
 181             <listitem>
 182                 <para>
 183                     <emphasis role="bold">direct-feedthrough:</emphasis> no
 184                 </para>
 185             </listitem>
 186             <listitem>
 187                 <para>
 188                     <emphasis role="bold">zero-crossing:</emphasis> no
 189                 </para>
 190             </listitem>
 191             <listitem>
 192                 <para>
 193                     <emphasis role="bold">mode:</emphasis> no
 194                 </para>
 195             </listitem>
 196             <listitem>
 197                 <para>
 198                     <emphasis role="bold">regular outputs:</emphasis>
 199                 </para>
 200                 <para>
 201                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 202                 </para>
 203             </listitem>
 204             <listitem>
 205                 <para>
 206                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
 207                 </para>
 208             </listitem>
 209             <listitem>
 210                 <para>
 211                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 212                 </para>
 213             </listitem>
 214             <listitem>
 215                 <para>
 216                     <emphasis role="bold">continuous-time state:</emphasis> no
 217                 </para>
 218             </listitem>
 219             <listitem>
 220                 <para>
 221                     <emphasis role="bold">discrete-time state:</emphasis> yes
 222                 </para>
 223             </listitem>
 224             <listitem>
 225                 <para>
 226                     <emphasis role="bold">object discrete-time state:</emphasis> no
 227                 </para>
 228             </listitem>
 229             <listitem>
 230                 <para>
 231                     <emphasis role="bold">name of computational function:</emphasis>
 232                     <emphasis role="italic">counter</emphasis>
 233                 </para>
 234             </listitem>
 235         </itemizedlist>
 236     </refsection>
 237     <refsection id="Example_Counter">
 238         <title>Example</title>
 239         <para>
 240             This diagram shows the Counter block output versus time.
 241         </para>
 242         <para/>
 243         <para>
 244             <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/counter_en_US.zcos">
 245                 <inlinemediaobject>
 246                     <imageobject>
 247                         <imagedata fileref="../../../../examples/sources_pal/en_US/counter_en_US.zcos" align="center" valign="middle"/>
 248                     </imageobject>
 249                 </inlinemediaobject>
 250             </link>
 251             <scilab:image><![CDATA[
 252 importXcosDiagram(SCI + "/modules/xcos/examples/sources_pal/en_US/counter_en_US.zcos");
 253 xcos_simulate(scs_m, 4);
 254 ]]></scilab:image>
 255         </para>
 256     </refsection>
 257     <refsection id="Interfacingfunction_Counter">
 258         <title>Interfacing function</title>
 259         <itemizedlist>
 260             <listitem>
 261                 <para>
 262                     <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/Counter.sci">SCI/modules/scicos_blocks/macros/Sources/Counter.sci</link>
 263                 </para>
 264             </listitem>
 265         </itemizedlist>
 266     </refsection>
 267     <refsection id="Computationalfunction_Counter">
 268         <title>Computational function</title>
 269         <itemizedlist>
 270             <listitem>
 271                 <para> SCI/modules/scicos_blocks/src/c/counter.c (Type 4)</para>
 272             </listitem>
 273         </itemizedlist>
 274     </refsection>
 275     <refsection id="Seealso_Counter">
 276         <title>See also</title>
 277         <itemizedlist>
 278             <listitem>
 279                 <link linkend="Modulo_Count">Modulo_Count</link>
 280             </listitem>
 281         </itemizedlist>
 282     </refsection>
 283 </refentry>