Merge remote-tracking branch 'origin/6.0'
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sinks_pal / CMSCOPE.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  * Copyright (C) 2018 - Samuel GOUGEON
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:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
27         xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
28         xml:id="CMSCOPE">
29     <refnamediv>
30         <refname>CMSCOPE</refname>
31         <refpurpose>Multi display scope in subplot(N,1)</refpurpose>
32     </refnamediv>
33     <refsection>
34         <title>Block Screenshot</title>
35         <inlinemediaobject>
36             <imageobject>
37                 <imagedata fileref="../../../../images/palettes/CMSCOPE.png" align="center"/>
38             </imageobject>
39         </inlinemediaobject>
40     </refsection>
41     <refsection id="Contents_CMSCOPE">
42         <title>Contents</title>
43         <itemizedlist>
44             <listitem>
45               <xref linkend="Description_CMSCOPE">Description</xref>
46             </listitem>
47             <listitem>
48               <xref linkend="Dialogbox_CMSCOPE">Parameters</xref>
49             </listitem>
50             <listitem>
51               <xref linkend="Defaultproperties_CMSCOPE">Default properties</xref>
52             </listitem>
53             <listitem>
54               <xref linkend="Interfacingfunction_CMSCOPE">Interfacing function</xref>
55             </listitem>
56             <listitem>
57               <xref linkend="Computationalfunction_CMSCOPE">Computational function</xref>
58             </listitem>
59             <listitem>
60               <xref linkend="Example_CMSCOPE">Example</xref>
61             </listitem>
62             <listitem>
63               <xref linkend="Seealso_CMSCOPE">See also</xref>
64             </listitem>
65         </itemizedlist>
66         <para/>
67     </refsection>
68
69     <refsection id="Description_CMSCOPE">
70         <title>Description</title>
71         <para>
72             When you start a simulation, Xcos open Scope windows.  The Scope
73             block displays its input with respect to simulation time. The Scope
74             block can have multiple axes (one per port); all axes have a common
75             time range with independent y-axes. The Scope allows you to adjust the
76             amount of time and the range of input values displayed.
77         </para>
78     </refsection>
79
80     <refsection id="Dialogbox_CMSCOPE">
81         <title>Parameters</title>
82         <inlinemediaobject>
83             <imageobject>
84                 <imagedata fileref="../../../../images/gui/CMSCOPE_gui.gif" align="center" style="float:right"/>
85                     <!-- align => Javahelp, style => Online -->
86             </imageobject>
87         </inlinemediaobject>
88         <itemizedlist>
89             <listitem>
90                 <para>
91                     <emphasis role="bold">Input ports sizes</emphasis>
92                 </para>
93                 <para> It allows multiple input ports.</para>
94                 <para> Properties : Type 'vec' of size -1 </para>
95             </listitem>
96             <listitem>
97                 <para>
98                     <emphasis role="bold">Drawing colors </emphasis>
99                 </para>
100                 <para>
101                     a vector of integers. The i-th element is the color number (≥ 0) or marker type (&lt; 0) used to draw the evolution of the i-th input port signal. See<emphasis role="bold">plot2d</emphasis> for color (dash type) definitions.
102                 </para>
103                 <para> Properties : Type 'vec' of size -1 </para>
104             </listitem>
105             <listitem>
106                 <para>
107                     <emphasis role="bold">Output window number</emphasis>
108                 </para>
109                 <para>
110                     The number of graphic window used for the display. It is often good to use high values to avoid conflict with palettes and Super Block windows. If default value is used<emphasis role="bold">(1)</emphasis> , Xcos define the output window number.
111                 </para>
112                 <para> Properties : Type 'vec' of size 1 </para>
113             </listitem>
114             <listitem>
115                 <para>
116                     <emphasis role="bold">Output window position</emphasis>
117                 </para>
118                 <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
119                 <para> Properties : Type 'vec' of size -1 </para>
120             </listitem>
121             <listitem>
122                 <para>
123                     <emphasis role="bold">Output window sizes</emphasis>
124                 </para>
125                 <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
126                 <para> Properties : Type 'vec' of size size -1 </para>
127             </listitem>
128             <listitem>
129                 <para>
130                     <emphasis role="bold">Ymin vector</emphasis>
131                 </para>
132                 <para> Minimum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
133                 <para> Properties : Type 'vec' of size size(%1,'*') </para>
134             </listitem>
135             <listitem>
136                 <para>
137                     <emphasis role="bold">Ymax vector</emphasis>
138                 </para>
139                 <para> Maximum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
140                 <para> Properties : Type 'vec' of size size(%1,'*') </para>
141             </listitem>
142             <listitem>
143                 <para>
144                     <emphasis role="bold">Refresh period</emphasis>
145                 </para>
146                 <para> Maximum value on the X-axis (time). The plot is redrawn when time reaches a multiple of this value.</para>
147                 <para> Properties : Type 'vec' of size size(%1,'*') </para>
148             </listitem>
149             <listitem>
150                 <para>
151                     <emphasis role="bold">Buffer size</emphasis>
152                 </para>
153                 <para>
154                     To improve efficiency it is possible to buffer the input data. The drawing is only done after each<emphasis role="bold">Buffer size</emphasis> call to the block.
155                 </para>
156                 <para> Properties : Type 'vec' of size 1 </para>
157             </listitem>
158             <listitem>
159                 <para>
160                     <emphasis role="bold">Accept herited events 0/1</emphasis>
161                 </para>
162                 <para>
163                     if 0<emphasis role="bold">CSCOPE_f</emphasis> draws a new point only when an event occurs on its event input port. if 1<emphasis role="bold">CSCOPE_f</emphasis> draws a new point when an event occurs on its event input port and when it's regular input changes due to an event on another upstream block (herited events).
164                 </para>
165                 <para> Properties : Type 'vec' of size 1 </para>
166             </listitem>
167             <listitem>
168                 <para>
169                     <emphasis role="bold">Name of Scope </emphasis>
170                 </para>
171                 <para> Name/label of the block.</para>
172                 <para> Properties : Type 'str' of size 1</para>
173             </listitem>
174         </itemizedlist>
175                 <para/>
176     </refsection>
177
178     <refsection id="Defaultproperties_CMSCOPE">
179         <title>Default properties</title>
180         <itemizedlist>
181             <listitem>
182                 <para>
183                     <emphasis role="bold">always active:</emphasis> no
184                 </para>
185             </listitem>
186             <listitem>
187                 <para>
188                     <emphasis role="bold">direct-feedthrough:</emphasis> yes
189                 </para>
190             </listitem>
191             <listitem>
192                 <para>
193                     <emphasis role="bold">zero-crossing:</emphasis> no
194                 </para>
195             </listitem>
196             <listitem>
197                 <para>
198                     <emphasis role="bold">mode:</emphasis> no
199                 </para>
200             </listitem>
201             <listitem>
202                 <para>
203                     <emphasis role="bold">regular inputs:</emphasis>
204                 </para>
205                 <para>
206                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
207                 </para>
208                 <para>
209                     <emphasis role="bold">- port 2 : size [1,1] / type 1</emphasis>
210                 </para>
211             </listitem>
212             <listitem>
213                 <para>
214                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
215                 </para>
216             </listitem>
217             <listitem>
218                 <para>
219                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
220                 </para>
221             </listitem>
222             <listitem>
223                 <para>
224                     <emphasis role="bold">continuous-time state:</emphasis> no
225                 </para>
226             </listitem>
227             <listitem>
228                 <para>
229                     <emphasis role="bold">discrete-time state:</emphasis> no
230                 </para>
231             </listitem>
232             <listitem>
233                 <para>
234                     <emphasis role="bold">object discrete-time state:</emphasis> no
235                 </para>
236             </listitem>
237             <listitem>
238                 <para>
239                     <emphasis role="bold">name of computational function:</emphasis>
240                     <emphasis role="italic">cmscope</emphasis>
241                 </para>
242             </listitem>
243         </itemizedlist>
244                 <para/>
245     </refsection>
246
247     <refsection id="Interfacingfunction_CMSCOPE">
248         <title>Interfacing function</title>
249         <itemizedlist>
250             <listitem>
251                 <para> SCI/modules/scicos_blocks/macros/Sinks/CMSCOPE.sci</para>
252             </listitem>
253         </itemizedlist>
254     </refsection>
255     <refsection id="Computationalfunction_CMSCOPE">
256         <title>Computational function</title>
257         <itemizedlist>
258             <listitem>
259                 <para> SCI/modules/scicos_blocks/src/c/cmscope.c (Type 4)</para>
260             </listitem>
261         </itemizedlist>
262                 <para/>
263     </refsection>
264
265     <refsection id="Example_CMSCOPE">
266         <title>Example</title>
267         <link type="scilab" linkend="scilab.xcos/xcos/tests/unit_tests/cmscope.zcos">
268             <inlinemediaobject>
269                 <imageobject>
270                     <imagedata fileref="../../../../tests/unit_tests/cmscope.zcos" align="center"/>
271                 </imageobject>
272             </inlinemediaobject>
273         </link>
274                 <para/>
275     </refsection>
276
277     <refsection id="Seealso_CMSCOPE" role="see also">
278         <title>See also</title>
279         <simplelist type="inline">
280             <member>
281                 <link linkend="CSCOPE">CSCOPE</link>
282             </member>
283             <member>
284                 <link linkend="CFSCOPE">CFSCOPE</link>
285             </member>
286             <member>
287                 <link linkend="CSCOPXY">CSCOPXY</link>
288             </member>
289             <member>
290                 <link linkend="CSCOPXY3D">CSCOPXY3D</link>
291             </member>
292         </simplelist>
293     </refsection>
294     <refsection id="Seealso_CMSCOPE">
295         <title>See also</title>
296         <itemizedlist>
297             <listitem>
298                 <para>
299                     <link linkend="SCALE_CMSCOPE">SCALE_CMSCOPE - Multi display scope with autoscale feature of graph</link>
300                 </para>
301             </listitem>
302         </itemizedlist>
303     </refsection>
304 </refentry>