helptools: regen xcos schema to pass help generation
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Portaction_pal / OUTIMPL_f.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"
26         xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:svg="http://www.w3.org/2000/svg"
27         xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
28         xmlns:scilab="http://www.scilab.org" xml:id="OUTIMPL_f" xml:lang="en_US">
29     <refnamediv>
30         <refname>OUTIMPL_f</refname>
31         <refpurpose>Output implicit port</refpurpose>
32     </refnamediv>
33     <refsection>
34         <title>Block Screenshot</title>
35         <inlinemediaobject>
36             <imageobject>
37                 <imagedata fileref="../../../../images/palettes/OUTIMPL_f.png" align="center"/>
38             </imageobject>
39         </inlinemediaobject>\r
40     </refsection>
41     <refsection id="Contents_OUTIMPL_f">
42         <title>Contents</title>
43         <itemizedlist>
44             <listitem>
45                 <xref linkend="Description_OUTIMPL_f">Description</xref>
46             </listitem>
47             <listitem>
48                 <xref linkend="Dialogbox_OUTIMPL_f">Parameters</xref>
49             </listitem>
50             <listitem>
51                 <xref linkend="Defaultproperties_OUTIMPL_f">Default properties</xref>
52             </listitem>
53             <listitem>
54                 <xref linkend="Example_OUTIMPL_f">Example</xref>
55             </listitem>
56             <listitem>
57                 <xref linkend="Interfacingfunction_OUTIMPL_f">Interfacing function</xref>
58             </listitem>
59             <listitem>
60                 <xref linkend="Seealso_OUTIMPL_f">See also</xref>
61             </listitem>
62         </itemizedlist>
63     </refsection>
64
65     <refsection id="Description_OUTIMPL_f">
66         <title>Description</title>
67         <para>
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.
69         </para>
70         <para>
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.
72         </para>
73     </refsection>
74
75     <refsection id="Dialogbox_OUTIMPL_f">
76         <title>Parameters</title>
77         <inlinemediaobject>
78             <imageobject>
79                 <imagedata fileref="../../../gui/portaction_pal/en_US/OUTIMPL_f_gui.png" align="center" style="float:right"/>
80                     <!-- align => Javahelp, style => Online -->
81             </imageobject>
82         </inlinemediaobject>
83         <itemizedlist>
84             <listitem>
85                 <para>
86                     <emphasis role="bold">Port number</emphasis>
87                 </para>
88                 <para> An integer defining the port number.</para>
89                 <para> Properties : Type 'vec' of size 1.</para>
90             </listitem>
91         </itemizedlist>
92     </refsection>
93     <refsection id="Defaultproperties_OUTIMPL_f">
94         <title>Default properties</title>
95         <itemizedlist>
96             <listitem>
97                 <para>
98                     <emphasis role="bold">always active:</emphasis> no
99                 </para>
100             </listitem>
101             <listitem>
102                 <para>
103                     <emphasis role="bold">direct-feedthrough:</emphasis> no
104                 </para>
105             </listitem>
106             <listitem>
107                 <para>
108                     <emphasis role="bold">zero-crossing:</emphasis> no
109                 </para>
110             </listitem>
111             <listitem>
112                 <para>
113                     <emphasis role="bold">mode:</emphasis> no
114                 </para>
115             </listitem>
116             <listitem>
117                 <para>
118                     <emphasis role="bold">regular inputs:</emphasis>
119                 </para>
120                 <para>
121                     <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
122                 </para>
123             </listitem>
124             <listitem>
125                 <para>
126                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
127                 </para>
128             </listitem>
129             <listitem>
130                 <para>
131                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
132                 </para>
133             </listitem>
134             <listitem>
135                 <para>
136                     <emphasis role="bold">continuous-time state:</emphasis> no
137                 </para>
138             </listitem>
139             <listitem>
140                 <para>
141                     <emphasis role="bold">discrete-time state:</emphasis> no
142                 </para>
143             </listitem>
144             <listitem>
145                 <para>
146                     <emphasis role="bold">object discrete-time state:</emphasis> no
147                 </para>
148             </listitem>
149             <listitem>
150                 <para>
151                     <emphasis role="bold">name of computational function:</emphasis>
152                     <emphasis role="italic">outimpl</emphasis>
153                 </para>
154             </listitem>
155         </itemizedlist>
156         <para/>
157     </refsection>
158     <refsection id="Example_OUTIMPL_f">
159         <title>Example</title>
160         <para>
161             In the following example the Super block is a basic transistor switch.
162         </para>
163         <para>
164             <link type="scilab" linkend="scilab.xcos/xcos/examples/portaction_pal/en_US/OUTIMPL_f_en_US.zcos">
165                 <inlinemediaobject>
166                     <imageobject>
167                         <imagedata fileref="../../../../examples/portaction_pal/en_US/OUTIMPL_f_en_US.zcos" align="center"/>
168                     </imageobject>
169                 </inlinemediaobject>
170             </link>
171         </para>
172         <para>
173             The following figure shows the output of the bloc :
174         </para>
175         <scilab:image><![CDATA[
176 // overload messagebox to avoid the "modelica compiler" message
177 function [btn] = messagebox(msg, msgboxtitle, msgboxicon, buttons, ismodal)
178     btn=1;
179 endfunction
180
181 importXcosDiagram(SCI + "/modules/xcos/examples/portaction_pal/en_US/OUTIMPL_f_en_US.zcos");
182 xcos_simulate(scs_m, 4);
183 ]]></scilab:image>
184     </refsection>
185     <refsection id="Interfacingfunction_OUTIMPL_f">
186         <title>Interfacing function</title>
187         <itemizedlist>
188             <listitem>
189                 <para>
190                     <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sinks/OUTIMPL_f.sci">SCI/modules/scicos_blocks/macros/Sinks/OUTIMPL_f.sci</link>
191                 </para>
192             </listitem>
193         </itemizedlist>
194     </refsection>
195     <refsection role="see also" id="Seealso_OUTIMPL_f">
196         <title>See also</title>
197         <itemizedlist>
198             <listitem>
199                 <link linkend="INIMPL_f">INIMPL_f</link>
200             </listitem>
201             <listitem>
202                 <link linkend="SUPER_f">SUPER_f</link>
203             </listitem>
204         </itemizedlist>
205     </refsection>
206 </refentry>