Xcos help: "Demonstrations blocks" palette examples
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Demonstrationsblocks_pal / BPLATFORM.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="BPLATFORM">
25     <refnamediv>
26         <refname>BPLATFORM</refname>
27         <refpurpose>Balls under a platform viewer</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/BPLATFORM.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_BPLATFORM">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="BPLATFORM">Balls under a platform viewer</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_BPLATFORM">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Dialogbox_BPLATFORM">Dialog box</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Defaultproperties_BPLATFORM">Default properties</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Interfacingfunction_BPLATFORM">Interfacing function</xref>
67                         </para>
68                     </listitem>
69                 </itemizedlist>
70             </listitem>
71         </itemizedlist>
72     </refsection>
73     <refsection id="Palette_BPLATFORM">
74         <title>Palette</title>
75         <itemizedlist>
76             <listitem>
77                 <para>
78                     <link linkend="Demonstrationsblocks_pal">Demonstrations blocks palette</link>
79                 </para>
80             </listitem>
81         </itemizedlist>
82     </refsection>
83     <refsection id="Dialogbox_BPLATFORM">
84         <title>Dialog box</title>
85         <para>
86             <inlinemediaobject>
87                 <imageobject>
88                     <imagedata fileref="../../../../images/gui/BPLATFORM_gui.gif" align="center" valign="middle"/>
89                 </imageobject>
90             </inlinemediaobject>
91         </para>
92     </refsection>
93     <refsection id="Defaultproperties_BPLATFORM">
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                 <para>
124                     <emphasis role="bold">- port 2 : size [1,1] / type 1</emphasis>
125                 </para>
126             </listitem>
127             <listitem>
128                 <para>
129                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
130                 </para>
131             </listitem>
132             <listitem>
133                 <para>
134                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
135                 </para>
136             </listitem>
137             <listitem>
138                 <para>
139                     <emphasis role="bold">continuous-time state:</emphasis> no
140                 </para>
141             </listitem>
142             <listitem>
143                 <para>
144                     <emphasis role="bold">discrete-time state:</emphasis> yes
145                 </para>
146             </listitem>
147             <listitem>
148                 <para>
149                     <emphasis role="bold">object discrete-time state:</emphasis> no
150                 </para>
151             </listitem>
152             <listitem>
153                 <para>
154                     <emphasis role="bold">name of computational function:</emphasis>
155                     <emphasis role="italic">bplatform2</emphasis>
156                 </para>
157             </listitem>
158         </itemizedlist>
159     </refsection>
160     <refsection id="Interfacingfunction_BPLATFORM">
161         <title>Interfacing function</title>
162         <itemizedlist>
163             <listitem>
164                 <para> SCI/modules/scicos_blocks/macros/Misc/BPLATFORM.sci</para>
165             </listitem>
166         </itemizedlist>
167     </refsection>
168     <refsection id="Example_BPLATFORM">
169         <title>BPLATFORM example:</title>
170         <link type="scilab" linkend="scilab.xcos/xcos/demos/ModelicaBlocks/Ball_Platform.zcos">
171             <inlinemediaobject>
172                 <imageobject>
173                     <imagedata align="center" fileref="../../../../demos/ModelicaBlocks/Ball_Platform.zcos" valign="middle"/>
174                 </imageobject>
175             </inlinemediaobject>
176         </link>
177     </refsection>
178 </refentry>