Xcos help: READC_f.xml contains invalid LaTeX code
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sources_pal / READC_f.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="READC_f">
25     <refnamediv>
26         <refname>READC_f</refname>
27         <refpurpose>Read binary data</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/READC_f.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_READC_f">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="READC_f">Read binary data</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_READC_f">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Description_READC_f">Description</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Dialogbox_READC_f">Dialog box</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Defaultproperties_READC_f">Default properties</xref>
67                         </para>
68                     </listitem>
69                     <listitem>
70                         <para>
71                             <xref linkend="Interfacingfunction_READC_f">Interfacing function</xref>
72                         </para>
73                     </listitem>
74                     <listitem>
75                         <para>
76                             <xref linkend="Computationalfunction_READC_f">Computational function</xref>
77                         </para>
78                     </listitem>
79                 </itemizedlist>
80             </listitem>
81         </itemizedlist>
82     </refsection>
83     <refsection id="Palette_READC_f">
84         <title>Palette</title>
85         <itemizedlist>
86             <listitem>
87                 <para>
88                     <link linkend="Sources_pal">Sources palette</link>
89                 </para>
90             </listitem>
91         </itemizedlist>
92     </refsection>
93     <refsection id="Description_READC_f">
94         <title>Description</title>
95         <para>
96             This block allows user to read data in a C file. <emphasis role="bold">Output record selection</emphasis> and <emphasis role="bold">Time record Selection</emphasis> allows the user to select data among file records. Each call to the block advance one record in the file.        
97         </para>
98     </refsection>
99     <refsection id="Dialogbox_READC_f">
100         <title>Dialog box</title>
101         <para>
102             <inlinemediaobject>
103                 <imageobject>
104                     <imagedata fileref="../../../../images/gui/READC_f_gui.gif" align="center" valign="middle"/>
105                 </imageobject>
106             </inlinemediaobject>
107         </para>
108         <para>
109             
110         </para>
111         <itemizedlist>
112             <listitem>
113                 <para>
114                     <emphasis role="bold">Time record selection</emphasis>
115                 </para>
116                 <para> an empty matrix or a positive integer.</para>
117                 <para> If an integer i is given the i th element of the read record is assumed to be the date of the output event.</para>
118                 <para> If empty no output event exists.</para>
119                 <para> Properties : Type 'vec' of size -1 </para>
120             </listitem>
121             <listitem>
122                 <para>
123                     <emphasis role="bold">Outputs record selection</emphasis>
124                 </para>
125                 <para>a vector of positive integer.</para>
126                 <para>
127                     <latex>$\left[ k_1 \ldots k_n \right]$</latex> : The <latex>$k_i$</latex>th element of the read record gives the value of <latex>$i^{th}$</latex> output.
128                 </para>
129                 <para> Properties : Type 'vec' of size -1 </para>
130             </listitem>
131             <listitem>
132                 <para>
133                     <emphasis role="bold">Input file name</emphasis>
134                 </para>
135                 <para> a character string defining the path of the file.</para>
136                 <para> Properties : Type 'str' of size 1 </para>
137             </listitem>
138             <listitem>
139                 <para>
140                     <emphasis role="bold">Input Format</emphasis>
141                 </para>
142                 <para> a character string defining the format to use.</para>
143                 <para> Properties : Type 'str' of size 1 </para>
144             </listitem>
145             <listitem>
146                 <para>
147                     <emphasis role="bold">Record size</emphasis>
148                 </para>
149                 <para> The file is supposed to be formed by a sequence of data with same format.</para>
150                 <para> These data are organized in a sequence of record each of them containing Record size data.</para>
151                 <para> Properties : Type 'vec' of size 1 </para>
152             </listitem>
153             <listitem>
154                 <para>
155                     <emphasis role="bold">Buffer size</emphasis>
156                 </para>
157                 <para> To improve efficiency it is possible to buffer the input data. Read on the file is only done after each Buffer size call to the block.</para>
158                 <para> Properties : Type 'vec' of size 1 </para>
159             </listitem>
160             <listitem>
161                 <para>
162                     <emphasis role="bold">Initial record index</emphasis>
163                 </para>
164                 <para> a scalar. This fixes the first record of the file to use.</para>
165                 <para> Properties : Type 'vec' of size 1 </para>
166             </listitem>
167             <listitem>
168                 <para>
169                     <emphasis role="bold">Swap mode 0/1</emphasis>
170                 </para>
171                 <para>
172                     With<emphasis role="bold">Swap mode=1</emphasis> the file is supposed to be coded in "little endian IEEE format" and data are swaped if necessary to match the IEEE format of the processor. If<emphasis role="bold">Swap mode=0</emphasis> then automatic bytes swap is disabled.
173                 </para>
174                 <para> Properties : Type 'vec' of size 1</para>
175             </listitem>
176         </itemizedlist>
177     </refsection>
178     <refsection id="Defaultproperties_READC_f">
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> no
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 outputs:</emphasis>
204                 </para>
205                 <para>
206                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
207                 </para>
208             </listitem>
209             <listitem>
210                 <para>
211                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
212                 </para>
213             </listitem>
214             <listitem>
215                 <para>
216                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
217                 </para>
218             </listitem>
219             <listitem>
220                 <para>
221                     <emphasis role="bold">continuous-time state:</emphasis> no
222                 </para>
223             </listitem>
224             <listitem>
225                 <para>
226                     <emphasis role="bold">discrete-time state:</emphasis> yes
227                 </para>
228             </listitem>
229             <listitem>
230                 <para>
231                     <emphasis role="bold">object discrete-time state:</emphasis> no
232                 </para>
233             </listitem>
234             <listitem>
235                 <para>
236                     <emphasis role="bold">name of computational function:</emphasis>
237                     <emphasis role="italic">readc</emphasis>
238                 </para>
239             </listitem>
240         </itemizedlist>
241     </refsection>
242     <refsection id="Interfacingfunction_READC_f">
243         <title>Interfacing function</title>
244         <itemizedlist>
245             <listitem>
246                 <para> SCI/modules/scicos_blocks/macros/Sources/READC_f.sci</para>
247             </listitem>
248         </itemizedlist>
249     </refsection>
250     <refsection id="Computationalfunction_READC_f">
251         <title>Computational function</title>
252         <itemizedlist>
253             <listitem>
254                 <para> SCI/modules/scicos_blocks/src/c/readc.c (Type 2)</para>
255             </listitem>
256         </itemizedlist>
257     </refsection>
258 </refentry>