b1185b30a5cbdead77cd9707c31cd5e6a8fe11ec
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Signalrouting_pal / M_SWITCH.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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="M_SWITCH">
25     <refnamediv>
26         <refname>M_SWITCH</refname>
27         <refpurpose>Multi-port switch</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/M_SWITCH.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_M_SWITCH">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="M_SWITCH">Multi-port switch</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_M_SWITCH">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Description_M_SWITCH">Description</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Dialogbox_M_SWITCH">Dialog box</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Defaultproperties_M_SWITCH">Default properties</xref>
67                         </para>
68                     </listitem>
69                     <listitem>
70                         <para>
71                             <xref linkend="Interfacingfunction_M_SWITCH">Interfacing function</xref>
72                         </para>
73                     </listitem>
74                     <listitem>
75                         <para>
76                             <xref linkend="Computationalfunction_M_SWITCH">Computational function</xref>
77                         </para>
78                     </listitem>
79                 </itemizedlist>
80             </listitem>
81         </itemizedlist>
82     </refsection>
83     <refsection id="Palette_M_SWITCH">
84         <title>Palette</title>
85         <itemizedlist>
86             <listitem>
87                 <para>
88                     <link linkend="Signalrouting_pal">Signal routing palette</link>
89                 </para>
90             </listitem>
91         </itemizedlist>
92     </refsection>
93     <refsection id="Description_M_SWITCH">
94         <title>Description</title>
95         <para>
96             The Multi-Port Switch block chooses between a number of inputs. The
97             first (top) input is called the control input, while the rest of the
98             inputs are called data inputs. The value of the control input
99             determines which data input is passed through to the output port.
100
101         </para>
102     </refsection>
103     <refsection id="Dialogbox_M_SWITCH">
104         <title>Dialog box</title>
105         <para>
106             <inlinemediaobject>
107                 <imageobject>
108                     <imagedata fileref="../../../../images/gui/M_SWITCH_gui.gif" align="center" valign="middle"/>
109                 </imageobject>
110             </inlinemediaobject>
111         </para>
112         <para>
113
114         </para>
115         <itemizedlist>
116             <listitem>
117                 <para>
118                     <emphasis role="bold">number of inputs</emphasis>
119                 </para>
120                 <para> Specify the number of data inputs to the block.</para>
121                 <para> Properties : Type 'vec' of size 1 </para>
122             </listitem>
123             <listitem>
124                 <para>
125                     <emphasis role="bold">zero base indexing </emphasis>
126                 </para>
127                 <para> If selected, the block uses zero-based indexing. Otherwise, the block uses one-based indexing.</para>
128                 <para> Properties : Type 'vec' of size 1 </para>
129             </listitem>
130             <listitem>
131                 <para>
132                     <emphasis role="bold">rounding rule: int </emphasis>
133                 </para>
134                 <para> Select the rounding mode for the output.</para>
135                 <para> Properties : Type 'vec' of size 1</para>
136             </listitem>
137         </itemizedlist>
138     </refsection>
139     <refsection id="Defaultproperties_M_SWITCH">
140         <title>Default properties</title>
141         <itemizedlist>
142             <listitem>
143                 <para>
144                     <emphasis role="bold">always active:</emphasis> no
145                 </para>
146             </listitem>
147             <listitem>
148                 <para>
149                     <emphasis role="bold">direct-feedthrough:</emphasis> yes
150                 </para>
151             </listitem>
152             <listitem>
153                 <para>
154                     <emphasis role="bold">zero-crossing:</emphasis> no
155                 </para>
156             </listitem>
157             <listitem>
158                 <para>
159                     <emphasis role="bold">mode:</emphasis> no
160                 </para>
161             </listitem>
162             <listitem>
163                 <para>
164                     <emphasis role="bold">regular inputs:</emphasis>
165                 </para>
166                 <para>
167                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
168                 </para>
169                 <para>
170                     <emphasis role="bold">- port 2 : size [-1,1] / type 0</emphasis>
171                 </para>
172                 <para>
173                     <emphasis role="bold">- port 3 : size [-1,1] / type 1</emphasis>
174                 </para>
175             </listitem>
176             <listitem>
177                 <para>
178                     <emphasis role="bold">regular outputs:</emphasis>
179                 </para>
180                 <para>
181                     <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
182                 </para>
183             </listitem>
184             <listitem>
185                 <para>
186                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
187                 </para>
188             </listitem>
189             <listitem>
190                 <para>
191                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
192                 </para>
193             </listitem>
194             <listitem>
195                 <para>
196                     <emphasis role="bold">continuous-time state:</emphasis> no
197                 </para>
198             </listitem>
199             <listitem>
200                 <para>
201                     <emphasis role="bold">discrete-time state:</emphasis> no
202                 </para>
203             </listitem>
204             <listitem>
205                 <para>
206                     <emphasis role="bold">object discrete-time state:</emphasis> no
207                 </para>
208             </listitem>
209             <listitem>
210                 <para>
211                     <emphasis role="bold">name of computational function:</emphasis>
212                     <emphasis role="italic">mswitch</emphasis>
213                 </para>
214             </listitem>
215         </itemizedlist>
216     </refsection>
217     <refsection id="Interfacingfunction_M_SWITCH">
218         <title>Interfacing function</title>
219         <itemizedlist>
220             <listitem>
221                 <para> SCI/modules/scicos_blocks/macros/Branching/M_SWITCH.sci</para>
222             </listitem>
223         </itemizedlist>
224     </refsection>
225     <refsection id="Computationalfunction_M_SWITCH">
226         <title>Computational function</title>
227         <itemizedlist>
228             <listitem>
229                 <para> SCI/modules/scicos_blocks/src/c/mswitch.c (Type 4)</para>
230             </listitem>
231         </itemizedlist>
232     </refsection>
233 </refentry>