4a28b1ac39d3174e214c68758599726002aedbb3
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Portaction_pal / OUTIMPL_f.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!--\r
3  * Xcos\r
4  *\r
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)\r
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)\r
7  * Copyright (C) 2011 - Bernard DUJARDIN <bernard.dujardin@contrib.scilab.org>\r
8  *\r
9  * This program is free software; you can redistribute it and/or modify\r
10  * it under the terms of the GNU General Public License as published by\r
11  * the Free Software Foundation; either version 2 of the License, or\r
12  *  (at your option) any later version.\r
13  *\r
14  * This program is distributed in the hope that it will be useful,\r
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
17  * GNU General Public License for more details.\r
18  *\r
19  * You should have received a copy of the GNU General Public License\r
20  * along with this program; if not, write to the Free Software\r
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.\r
22  *\r
23  * See the file ./license.txt\r
24  -->\r
25 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
26         xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:svg="http://www.w3.org/2000/svg"\r
27         xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"\r
28         xmlns:scilab="http://www.scilab.org" xml:id="OUTIMPL_f" xml:lang="en_US">\r
29     <refnamediv>\r
30         <refname>OUTIMPL_f</refname>\r
31         <refpurpose>Output implicit port</refpurpose>\r
32     </refnamediv>\r
33     <refsection>\r
34         <title>Block Screenshot</title>
35         <inlinemediaobject>\r
36             <imageobject>\r
37                 <imagedata fileref="../../../../images/palettes/OUTIMPL_f.png" align="center"/>\r
38             </imageobject>\r
39         </inlinemediaobject>\r\r
40     </refsection>\r
41     <refsection id="Contents_OUTIMPL_f">\r
42         <title>Contents</title>\r
43         <itemizedlist>\r
44             <listitem>\r
45                 <xref linkend="Description_OUTIMPL_f">Description</xref>\r
46             </listitem>\r
47             <listitem>\r
48                 <xref linkend="Dialogbox_OUTIMPL_f">Parameters</xref>\r
49             </listitem>\r
50             <listitem>\r
51                 <xref linkend="Defaultproperties_OUTIMPL_f">Default properties</xref>\r
52             </listitem>\r
53             <listitem>\r
54                 <xref linkend="Example_OUTIMPL_f">Example</xref>\r
55             </listitem>\r
56             <listitem>\r
57                 <xref linkend="Interfacingfunction_OUTIMPL_f">Interfacing function</xref>\r
58             </listitem>\r
59             <listitem>\r
60                 <xref linkend="Seealso_OUTIMPL_f">See also</xref>\r
61             </listitem>\r
62         </itemizedlist>\r
63     </refsection>\r
64 \r
65     <refsection id="Description_OUTIMPL_f">\r
66         <title>Description</title>\r
67         <para>\r
68             This block represents a regular implicit port. It must only be used inside a Xcos Super Block and be connected to an implicit output of an internal implicit output in the sub-system.\r
69         </para>\r
70         <para>\r
71             This block is a signal link from outside of a system into a sub-system. In a Super Block, the implicit's output ports must be numbered from 1 to the total number of implicit's output ports. You can set it with the <emphasis role="bold">Port number</emphasis> parameter.\r
72         </para>\r
73     </refsection>\r
74 \r
75     <refsection id="Dialogbox_OUTIMPL_f">\r
76         <title>Parameters</title>\r
77         <inlinemediaobject>\r
78             <imageobject>\r
79                 <imagedata fileref="../../../gui/portaction_pal/en_US/OUTIMPL_f_gui.png" align="center" style="float:right"/>\r
80                     <!-- align => Javahelp, style => Online -->\r
81             </imageobject>\r
82         </inlinemediaobject>\r
83         <itemizedlist>\r
84             <listitem>\r
85                 <para>\r
86                     <emphasis role="bold">Port number</emphasis>\r
87                 </para>\r
88                 <para> An integer defining the port number.</para>\r
89                 <para> Properties : Type 'vec' of size 1.</para>\r
90             </listitem>\r
91         </itemizedlist>\r
92     </refsection>\r
93     <refsection id="Defaultproperties_OUTIMPL_f">\r
94         <title>Default properties</title>\r
95         <itemizedlist>\r
96             <listitem>\r
97                 <para>\r
98                     <emphasis role="bold">always active:</emphasis> no\r
99                 </para>\r
100             </listitem>\r
101             <listitem>\r
102                 <para>\r
103                     <emphasis role="bold">direct-feedthrough:</emphasis> no\r
104                 </para>\r
105             </listitem>\r
106             <listitem>\r
107                 <para>\r
108                     <emphasis role="bold">zero-crossing:</emphasis> no\r
109                 </para>\r
110             </listitem>\r
111             <listitem>\r
112                 <para>\r
113                     <emphasis role="bold">mode:</emphasis> no\r
114                 </para>\r
115             </listitem>\r
116             <listitem>\r
117                 <para>\r
118                     <emphasis role="bold">regular inputs:</emphasis>\r
119                 </para>\r
120                 <para>\r
121                     <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>\r
122                 </para>\r
123             </listitem>\r
124             <listitem>\r
125                 <para>\r
126                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0\r
127                 </para>\r
128             </listitem>\r
129             <listitem>\r
130                 <para>\r
131                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0\r
132                 </para>\r
133             </listitem>\r
134             <listitem>\r
135                 <para>\r
136                     <emphasis role="bold">continuous-time state:</emphasis> no\r
137                 </para>\r
138             </listitem>\r
139             <listitem>\r
140                 <para>\r
141                     <emphasis role="bold">discrete-time state:</emphasis> no\r
142                 </para>\r
143             </listitem>\r
144             <listitem>\r
145                 <para>\r
146                     <emphasis role="bold">object discrete-time state:</emphasis> no\r
147                 </para>\r
148             </listitem>\r
149             <listitem>\r
150                 <para>\r
151                     <emphasis role="bold">name of computational function:</emphasis>\r
152                     <emphasis role="italic">outimpl</emphasis>\r
153                 </para>\r
154             </listitem>\r
155         </itemizedlist>\r
156         <para/>\r
157     </refsection>\r
158     <refsection id="Example_OUTIMPL_f">\r
159         <title>Example</title>\r
160         <para>\r
161             In the following example the Super block is a basic transistor switch.\r
162         </para>\r
163         <para>\r
164             <link type="scilab" linkend="scilab.xcos/xcos/examples/portaction_pal/en_US/OUTIMPL_f_en_US.zcos">\r
165                 <inlinemediaobject>\r
166                     <imageobject>\r
167                         <imagedata fileref="../../../../examples/portaction_pal/en_US/OUTIMPL_f_en_US.zcos" align="center"/>\r
168                     </imageobject>\r
169                 </inlinemediaobject>\r
170             </link>\r
171         </para>\r
172         <para>\r
173             The following figure shows the output of the bloc :\r
174         </para>\r
175         <scilab:image><![CDATA[\r
176 // overload messagebox to avoid the "modelica compiler" message\r
177 function [btn] = messagebox(msg, msgboxtitle, msgboxicon, buttons, ismodal)\r
178     btn=1;\r
179 endfunction\r
180 \r
181 importXcosDiagram(SCI + "/modules/xcos/examples/portaction_pal/en_US/OUTIMPL_f_en_US.zcos");\r
182 xcos_simulate(scs_m, 4);\r
183 ]]></scilab:image>\r
184     </refsection>\r
185     <refsection id="Interfacingfunction_OUTIMPL_f">\r
186         <title>Interfacing function</title>\r
187         <itemizedlist>\r
188             <listitem>\r
189                 <para>\r
190                     <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sinks/OUTIMPL_f.sci">SCI/modules/scicos_blocks/macros/Sinks/OUTIMPL_f.sci</link>\r
191                 </para>\r
192             </listitem>\r
193         </itemizedlist>\r
194     </refsection>\r
195     <refsection role="see also" id="Seealso_OUTIMPL_f">\r
196         <title>See also</title>\r
197         <itemizedlist>\r
198             <listitem>\r
199                 <link linkend="INIMPL_f">INIMPL_f</link>\r
200             </listitem>\r
201             <listitem>\r
202                 <link linkend="SUPER_f">SUPER_f</link>\r
203             </listitem>\r
204         </itemizedlist>\r
205     </refsection>\r
206 </refentry>\r