0eaf46325567358622bb37746ea57c08e208cfc1
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sinks_pal / AA_Sinks_pal.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., 675 Mass Ave, Cambridge, MA 02139, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry version="5.0-subset Scilab" xml:id="Sinks_pal"
25           xmlns="http://docbook.org/ns/docbook"
26           xmlns:xlink="http://www.w3.org/1999/xlink"
27           xmlns:svg="http://www.w3.org/2000/svg"
28           xmlns:ns4="http://www.w3.org/1999/xhtml"
29           xmlns:mml="http://www.w3.org/1998/Math/MathML"
30           xmlns:db="http://docbook.org/ns/docbook">
31   <refnamediv>
32     <refname>Sinks_pal</refname>
33
34     <refpurpose>Sinks palette</refpurpose>
35   </refnamediv>
36
37   <refsection>
38     <title>Block Screenshot</title>
39
40     <para>
41     <inlinemediaobject>
42       <imageobject>
43         <imagedata linkend="AFFICH_m" fileref="../../../../../../modules/xcos/images/palettes/AFFICH_m.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
44       </imageobject>
45     </inlinemediaobject>
46     <inlinemediaobject>
47       <imageobject>
48         <imagedata linkend="CANIMXY" fileref="../../../../../../modules/xcos/images/palettes/CANIMXY.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
49       </imageobject>
50     </inlinemediaobject>
51     <inlinemediaobject>
52       <imageobject>
53         <imagedata linkend="CANIMXY3D" fileref="../../../../../../modules/xcos/images/palettes/CANIMXY3D.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
54       </imageobject>
55     </inlinemediaobject>
56     <inlinemediaobject>
57       <imageobject>
58         <imagedata linkend="CFSCOPE" fileref="../../../../../../modules/xcos/images/palettes/CFSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
59       </imageobject>
60     </inlinemediaobject>
61     <inlinemediaobject>
62       <imageobject>
63         <imagedata linkend="CLKOUTV_f" fileref="../../../../../../modules/xcos/images/palettes/CLKOUTV_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
64       </imageobject>
65     </inlinemediaobject>
66     <inlinemediaobject>
67       <imageobject>
68         <imagedata linkend="CMAT3D" fileref="../../../../../../modules/xcos/images/palettes/CMAT3D.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
69       </imageobject>
70     </inlinemediaobject>
71     <inlinemediaobject>
72       <imageobject>
73         <imagedata linkend="CMATVIEW" fileref="../../../../../../modules/xcos/images/palettes/CMATVIEW.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
74       </imageobject>
75     </inlinemediaobject>
76     <inlinemediaobject>
77       <imageobject>
78         <imagedata linkend="CMSCOPE" fileref="../../../../../../modules/xcos/images/palettes/CMSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
79       </imageobject>
80     </inlinemediaobject>
81     <inlinemediaobject>
82       <imageobject>
83         <imagedata linkend="CSCOPE" fileref="../../../../../../modules/xcos/images/palettes/CSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
84       </imageobject>
85     </inlinemediaobject>
86     <inlinemediaobject>
87       <imageobject>
88         <imagedata linkend="CSCOPXY" fileref="../../../../../../modules/xcos/images/palettes/CSCOPXY.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
89       </imageobject>
90     </inlinemediaobject>
91     <inlinemediaobject>
92       <imageobject>
93         <imagedata linkend="CSCOPXY3D" fileref="../../../../../../modules/xcos/images/palettes/CSCOPXY3D.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
94       </imageobject>
95     </inlinemediaobject>
96     <inlinemediaobject>
97       <imageobject>
98         <imagedata linkend="ENDBLK" fileref="../../../../../../modules/xcos/images/palettes/ENDBLK.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
99       </imageobject>
100     </inlinemediaobject>
101     <inlinemediaobject>
102       <imageobject>
103         <imagedata linkend="END_c" fileref="../../../../../../modules/xcos/images/palettes/END_c.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
104       </imageobject>
105     </inlinemediaobject>
106     <inlinemediaobject>
107       <imageobject>
108         <imagedata linkend="HALT_f" fileref="../../../../../../modules/xcos/images/palettes/HALT_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
109       </imageobject>
110     </inlinemediaobject>
111     <inlinemediaobject>
112       <imageobject>
113         <imagedata linkend="OUTIMPL_f" fileref="../../../../../../modules/xcos/images/palettes/OUTIMPL_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
114       </imageobject>
115     </inlinemediaobject>
116     <inlinemediaobject>
117       <imageobject>
118         <imagedata linkend="OUT_f" fileref="../../../../../../modules/xcos/images/palettes/OUT_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
119       </imageobject>
120     </inlinemediaobject>
121     <inlinemediaobject>
122       <imageobject>
123         <imagedata linkend="TOWS_c" fileref="../../../../../../modules/xcos/images/palettes/TOWS_c.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
124       </imageobject>
125     </inlinemediaobject>
126     <inlinemediaobject>
127       <imageobject>
128         <imagedata linkend="TRASH_f" fileref="../../../../../../modules/xcos/images/palettes/TRASH_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
129       </imageobject>
130     </inlinemediaobject>
131     <inlinemediaobject>
132       <imageobject>
133         <imagedata linkend="WFILE_f" fileref="../../../../../../modules/xcos/images/palettes/WFILE_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
134       </imageobject>
135     </inlinemediaobject>
136     <inlinemediaobject>
137       <imageobject>
138         <imagedata linkend="WRITEAU_f" fileref="../../../../../../modules/xcos/images/palettes/WRITEAU_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
139       </imageobject>
140     </inlinemediaobject>
141     <inlinemediaobject>
142       <imageobject>
143         <imagedata linkend="WRITEC_f" fileref="../../../../../../modules/xcos/images/palettes/WRITEC_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
144       </imageobject>
145     </inlinemediaobject>
146     </para>
147   </refsection>
148
149   <refsection id="Module_Sinks_pal">
150     <title>Module</title>
151
152     <itemizedlist>
153       <listitem>
154         <para>
155           <link linkend="xcos">xcos</link>
156         </para>
157       </listitem>
158     </itemizedlist>
159   </refsection>
160
161   <refsection id="Description_Sinks_pal">
162     <title>Description</title>
163
164       <para>In Sinks palette, you can find a variety of blocks used to display
165       (Scope) and write data during simulation and also some output ports used
166       in superblocks.</para>
167
168       <para>The blocks of that palette doesn't have regular output
169       ports.</para>
170   </refsection>
171
172   <refsection id="Blocks_Sinks_pal">
173     <title>Blocks</title>
174
175     <itemizedlist>
176       <listitem>
177         <para>
178           <link linkend="AFFICH_m">AFFICH_m - Display</link>
179         </para>
180       </listitem>
181
182       <listitem>
183         <para>
184           <link linkend="CANIMXY">CANIMXY - y=f(x) animated viewer</link>
185         </para>
186       </listitem>
187
188       <listitem>
189         <para>
190           <link linkend="CANIMXY3D">CANIMXY3D - z=f(x,y) animated
191           viewer</link>
192         </para>
193       </listitem>
194
195       <listitem>
196         <para>
197           <link linkend="CFSCOPE">CFSCOPE - Floating point scope</link>
198         </para>
199       </listitem>
200           
201           <listitem>
202         <para>
203           <link linkend="CLKOUTV_f">CLKOUTV_f - Output activation port</link>
204         </para>
205       </listitem>
206
207       <listitem>
208         <para>
209           <link linkend="CMAT3D">CMAT3D - Matrix z values 3D viewer</link>
210         </para>
211       </listitem>
212
213       <listitem>
214         <para>
215           <link linkend="CMATVIEW">CMATVIEW - Matrix Colormapped viewer</link>
216         </para>
217       </listitem>
218
219       <listitem>
220         <para>
221           <link linkend="CMSCOPE">CMSCOPE - Multi display scope</link>
222         </para>
223       </listitem>
224
225       <listitem>
226         <para>
227           <link linkend="CSCOPE">CSCOPE - Single Display Scope</link>
228         </para>
229       </listitem>
230
231       <listitem>
232         <para>
233           <link linkend="CSCOPXY">CSCOPXY - y=f(x) permanent viewer</link>
234         </para>
235       </listitem>
236
237       <listitem>
238         <para>
239           <link linkend="CSCOPXY3D">CSCOPXY3D - z=f(x,y) permanent
240           viewer</link>
241         </para>
242       </listitem>
243           
244           <listitem>
245         <para>
246           <link linkend="ENDBLK">ENDBLK - END block
247           viewer</link>
248         </para>
249       </listitem>
250           
251           <listitem>
252         <para>
253           <link linkend="END_c">END_c - END_c block
254           viewer</link>
255         </para>
256       </listitem>
257           
258           <listitem>
259         <para>
260           <link linkend="HALT_f">HALT_f - Halt block
261           viewer</link>
262         </para>
263       </listitem>
264           
265           <listitem>
266         <para>
267           <link linkend="OUTIMPL_f">OUTIMPL_f - Output implicit port
268           viewer</link>
269         </para>
270       </listitem>
271           
272           <listitem>
273         <para>
274           <link linkend="OUT_f">OUT_f - Output port
275           viewer</link>
276         </para>
277       </listitem>
278
279       <listitem>
280         <para>
281           <link linkend="TOWS_c">TOWS_c - Data to Scilab worspace</link>
282         </para>
283       </listitem>
284
285       <listitem>
286         <para>
287           <link linkend="TRASH_f">TRASH_f — Trash block</link>
288         </para>
289       </listitem>
290
291       <listitem>
292         <para>
293           <link linkend="WFILE_f">WFILE_f — Write to file</link>
294         </para>
295       </listitem>
296
297       <listitem>
298         <para>
299           <link linkend="WRITEAU_f">WRITEAU_f — Write AU sound file</link>
300         </para>
301       </listitem>
302
303       <listitem>
304         <para>
305           <link linkend="WRITEC_f">Write binary data</link>
306         </para>
307       </listitem>
308     </itemizedlist>
309   </refsection>
310 </refentry>