f72f9dd125fadfa5f29b7efc0ecd3c84f97a580b
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sources_pal / Sigbuilder.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"
25         xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
26         xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
27         xml:id="Sigbuilder" xml:lang="en_US">
28     <refnamediv>
29         <refname>Sigbuilder</refname>
30         <refpurpose>Signal creator/generator</refpurpose>
31     </refnamediv>
32     <refsection>
33         <title>Block Screenshot</title>
34         <inlinemediaobject>
35             <imageobject>
36                 <imagedata fileref="../../../../images/palettes/Sigbuilder.png" align="center"/>
37             </imageobject>
38         </inlinemediaobject>
39     </refsection>
40
41     <refsection id="Contents_Sigbuilder">
42         <title>Contents</title>
43         <itemizedlist>
44             <listitem>
45                 <xref linkend="Description_Sigbuilder">Description</xref>
46             </listitem>
47             <listitem>
48                 <xref linkend="Dialogbox_Sigbuilder">Parameters</xref>
49             </listitem>
50             <listitem>
51                 <xref linkend="Defaultproperties_Sigbuilder">Default properties</xref>
52             </listitem>
53             <listitem>
54                 <xref linkend="Interfacingfunction_Sigbuilder">Interfacing function</xref>
55             </listitem>
56             <listitem>
57                 <xref linkend="Sigbuilder">Compiled Super Block content</xref>
58             </listitem>
59         </itemizedlist>
60     </refsection>
61
62     <refsection id="Description_Sigbuilder">
63         <title>Description</title>
64         <para>
65             The Signal Builder block is a superblock containing a block whose output event
66             port is connected to its input event port. This event feedback gives
67             the possibility to generate events at discontinuous point of the
68             signal. The generated events automatically restart the numerical
69             solver and avoids numerical problems. The generated event is also made
70             available to the user for possible use. Remind that if higher
71             interpolation methods are used, the events are generated only at the
72             beginning and at the end of the signal.
73         </para>
74     </refsection>
75
76     <refsection id="Dialogbox_Sigbuilder">
77         <title>Parameters</title>
78         <inlinemediaobject>
79             <imageobject>
80                 <imagedata fileref="../../../../images/gui/Sigbuilder_gui.gif"
81                            align="center" style="float:right"/>
82                     <!-- align => Javahelp, style => Online -->
83             </imageobject>
84         </inlinemediaobject>
85         <para>
86             The parameters of  Sigbuilder block is the same as that of block.
87         </para>
88     </refsection>
89
90     <refsection id="Defaultproperties_Sigbuilder">
91         <title>Default properties</title>
92         <itemizedlist>
93             <listitem>
94                 <para>
95                     <emphasis role="bold">always active:</emphasis> no
96                 </para>
97             </listitem>
98             <listitem>
99                 <para>
100                     <emphasis role="bold">direct-feedthrough:</emphasis> no
101                 </para>
102             </listitem>
103             <listitem>
104                 <para>
105                     <emphasis role="bold">zero-crossing:</emphasis> no
106                 </para>
107             </listitem>
108             <listitem>
109                 <para>
110                     <emphasis role="bold">mode:</emphasis> no
111                 </para>
112             </listitem>
113             <listitem>
114                 <para>
115                     <emphasis role="bold">regular outputs:</emphasis>
116                 </para>
117                 <para>
118                     <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
119                 </para>
120             </listitem>
121             <listitem>
122                 <para>
123                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
124                 </para>
125             </listitem>
126             <listitem>
127                 <para>
128                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 1
129                 </para>
130             </listitem>
131             <listitem>
132                 <para>
133                     <emphasis role="bold">continuous-time state:</emphasis> no
134                 </para>
135             </listitem>
136             <listitem>
137                 <para>
138                     <emphasis role="bold">discrete-time state:</emphasis> no
139                 </para>
140             </listitem>
141             <listitem>
142                 <para>
143                     <emphasis role="bold">object discrete-time state:</emphasis> no
144                 </para>
145             </listitem>
146             <listitem>
147                 <para>
148                     <emphasis role="bold">name of computational function:</emphasis>
149                     <emphasis role="italic">csuper</emphasis>
150                 </para>
151             </listitem>
152         </itemizedlist>
153         <para/>
154     </refsection>
155
156     <refsection id="Interfacingfunction_Sigbuilder">
157         <title>Interfacing function</title>
158         <itemizedlist>
159             <listitem>
160                 <para> SCI/modules/scicos_blocks/macros/Sources/Sigbuilder.sci</para>
161             </listitem>
162         </itemizedlist>
163     </refsection>
164 </refentry>