d2a87808f1071597d3fe5efa66700711b284e9ad
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Userdefinedfunctions_pal / scifunc_block_m.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="scifunc_block_m">
25     <refnamediv>
26         <refname>scifunc_block_m</refname>
27         <refpurpose>Scilab function block</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/scifunc_block_m.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_scifunc_block_m">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="scifunc_block_m">Scilab function block</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_scifunc_block_m">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Description_scifunc_block_m">Description</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Dialogbox_scifunc_block_m">Dialog box</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Defaultproperties_scifunc_block_m">Default properties</xref>
67                         </para>
68                     </listitem>
69                     <listitem>
70                         <para>
71                             <xref linkend="Interfacingfunction_scifunc_block_m">Interfacing function</xref>
72                         </para>
73                     </listitem>
74                     <listitem>
75                         <para>
76                             <xref linkend="Computationalfunction_scifunc_block_m">Computational function</xref>
77                         </para>
78                     </listitem>
79                 </itemizedlist>
80             </listitem>
81         </itemizedlist>
82     </refsection>
83     <refsection id="Palette_scifunc_block_m">
84         <title>Palette</title>
85         <itemizedlist>
86             <listitem>
87                 <para>
88                     <link linkend="Userdefinedfunctions_pal">User defined functions palette</link>
89                 </para>
90             </listitem>
91         </itemizedlist>
92     </refsection>
93     <refsection id="Description_scifunc_block_m">
94         <title>Description</title>
95         <para>
96             This block can realize any type of Scicos block. The function of the
97             block is defined interactively using dialogue boxes and in Scilab
98             language. During simulation, these instructions are interpreted by
99             Scilab; the simulation of diagrams that include these types of blocks
100             is slower. For more information see Scicos reference manual.
101         </para>
102     </refsection>
103     <refsection id="Dialogbox_scifunc_block_m">
104         <title>Dialog box</title>
105         <para>
106             <inlinemediaobject>
107                 <imageobject>
108                     <imagedata fileref="../../../../images/gui/scifunc_block_m_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">input ports sizes</emphasis>
119                 </para>
120                 <para> a scalar. Number of regular input ports</para>
121                 <para> Properties : Type 'vec' of size -1 </para>
122             </listitem>
123             <listitem>
124                 <para>
125                     <emphasis role="bold">output port sizes</emphasis>
126                 </para>
127                 <para> a scalar. Number of regular output ports</para>
128                 <para> Properties : Type 'vec' of size -1 </para>
129             </listitem>
130             <listitem>
131                 <para>
132                     <emphasis role="bold">input event ports sizes</emphasis>
133                 </para>
134                 <para> a scalar. Number of input event ports</para>
135                 <para> Properties : Type 'vec' of size -1 </para>
136             </listitem>
137             <listitem>
138                 <para>
139                     <emphasis role="bold">output events ports sizes</emphasis>
140                 </para>
141                 <para> a scalar. Number of output event ports</para>
142                 <para> Properties : Type 'vec' of size -1 </para>
143             </listitem>
144             <listitem>
145                 <para>
146                     <emphasis role="bold">initial continuous state</emphasis>
147                 </para>
148                 <para> a column vector.</para>
149                 <para> Properties : Type 'vec' of size -1 </para>
150             </listitem>
151             <listitem>
152                 <para>
153                     <emphasis role="bold">initial discrete state</emphasis>
154                 </para>
155                 <para> a column vector.</para>
156                 <para> Properties : Type 'vec' of size -1 </para>
157             </listitem>
158             <listitem>
159                 <para>
160                     <emphasis role="bold">System parameters vector</emphasis>
161                 </para>
162                 <para>
163                     a string: c or d (<emphasis role="bold">CBB</emphasis> or<emphasis role="bold">     DBB</emphasis> ), other types are not supported.
164                 </para>
165                 <para> Properties : Type 'vec' of size -1 </para>
166             </listitem>
167             <listitem>
168                 <para>
169                     <emphasis role="bold">initial firing vector </emphasis>
170                 </para>
171                 <para> vector. Size of this vector corresponds to the number of event outputs. The value of the i-th entry specifies the time of the preprogrammed event firing on the i-th output event port. If less than zero, no event is preprogrammed.</para>
172                 <para> Properties : Type 'vec' of size sum(%4) </para>
173             </listitem>
174             <listitem>
175                 <para>
176                     <emphasis role="bold">is block always active </emphasis>
177                 </para>
178                 <para> other dialogues are opened consecutively where used may input Scilab code associated with the computations needed (block initialization, outputs, continuous and discrete state, output events date, block ending)</para>
179                 <para> Properties : Type 'vec' of size 1</para>
180             </listitem>
181         </itemizedlist>
182     </refsection>
183     <refsection id="Defaultproperties_scifunc_block_m">
184         <title>Default properties</title>
185         <itemizedlist>
186             <listitem>
187                 <para>
188                     <emphasis role="bold">always active:</emphasis> no
189                 </para>
190             </listitem>
191             <listitem>
192                 <para>
193                     <emphasis role="bold">direct-feedthrough:</emphasis> yes
194                 </para>
195             </listitem>
196             <listitem>
197                 <para>
198                     <emphasis role="bold">zero-crossing:</emphasis> no
199                 </para>
200             </listitem>
201             <listitem>
202                 <para>
203                     <emphasis role="bold">mode:</emphasis> no
204                 </para>
205             </listitem>
206             <listitem>
207                 <para>
208                     <emphasis role="bold">regular inputs:</emphasis>
209                 </para>
210                 <para>
211                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
212                 </para>
213             </listitem>
214             <listitem>
215                 <para>
216                     <emphasis role="bold">regular outputs:</emphasis>
217                 </para>
218                 <para>
219                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
220                 </para>
221             </listitem>
222             <listitem>
223                 <para>
224                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
225                 </para>
226             </listitem>
227             <listitem>
228                 <para>
229                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
230                 </para>
231             </listitem>
232             <listitem>
233                 <para>
234                     <emphasis role="bold">continuous-time state:</emphasis> no
235                 </para>
236             </listitem>
237             <listitem>
238                 <para>
239                     <emphasis role="bold">discrete-time state:</emphasis> no
240                 </para>
241             </listitem>
242             <listitem>
243                 <para>
244                     <emphasis role="bold">object discrete-time state:</emphasis> no
245                 </para>
246             </listitem>
247             <listitem>
248                 <para>
249                     <emphasis role="bold">name of computational function:</emphasis>
250                     <emphasis role="italic">scifunc</emphasis>
251                 </para>
252             </listitem>
253         </itemizedlist>
254     </refsection>
255     <refsection id="Example_scifunc_block_m">
256         <title>Example</title>
257         <para>
258             <link type="scilab" linkend="scilab.xcos/xcos/examples/userdefinedfunctions_pal/en_US/scifunc_block_m_en_US.zcos">
259                 <inlinemediaobject>
260                     <imageobject>
261                         <imagedata fileref="../../../../examples/userdefinedfunctions_pal/en_US/scifunc_block_m_en_US.zcos" align="center" valign="middle"/>
262                     </imageobject>
263                 </inlinemediaobject>
264             </link>
265         </para>
266         <scilab:image><![CDATA[
267 importXcosDiagram(SCI + "/modules/xcos/examples/userdefinedfunctions_pal/en_US/scifunc_block_m_en_US.zcos");
268 xcos_simulate(scs_m, 4);
269 ]]></scilab:image>
270     </refsection>
271     <refsection id="Interfacingfunction_scifunc_block_m">
272         <title>Interfacing function</title>
273         <itemizedlist>
274             <listitem>
275                 <para> SCI/modules/scicos_blocks/macros/Misc/scifunc_block_m.sci</para>
276             </listitem>
277         </itemizedlist>
278     </refsection>
279     <refsection id="Computationalfunction_scifunc_block_m">
280         <title>Computational function</title>
281         <itemizedlist>
282             <listitem>
283                 <para> SCI/modules/scicos/src/fortran/scifunc.f (Type 3)</para>
284             </listitem>
285         </itemizedlist>
286     </refsection>
287 </refentry>