Xcos help: fixed the simulation time, resized images, deleted unused links.
[scilab.git] / scilab / modules / xcos / help / fr_FR / palettes / Sources_pal / RFILE_f.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2011 - Bernard DUJARDIN <bernard.dujardin@contrib.scilab.org>
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="RFILE_f" xml:lang="fr_FR">
14     <refnamediv>
15         <refname>RFILE_f</refname>
16         <refpurpose>Lecture dans un fichier</refpurpose>
17     </refnamediv>
18     <refsection>
19         <title>Aperçu</title>
20         <para>
21             <inlinemediaobject>
22                 <imageobject>
23                     <imagedata fileref="../../../../images/palettes/RFILE_f.png" align="center" valign="middle"/>
24                 </imageobject>
25             </inlinemediaobject>
26         </para>
27     </refsection>
28     <refsection id="Contents_RFILE_f">
29         <title>Contenu</title>
30         <itemizedlist>
31             <listitem>
32                 <para>
33                     <link linkend="RFILE_f">Lecture dans un fichier</link>
34                 </para>
35             </listitem>
36             <listitem>
37                 <itemizedlist>
38                     <listitem>
39                         <para>
40                             <xref linkend="Palette_RFILE_f">Palette</xref>
41                         </para>
42                     </listitem>
43                     <listitem>
44                         <para>
45                             <xref linkend="Description_RFILE_f">Description</xref>
46                         </para>
47                     </listitem>
48                     <listitem>
49                         <para>
50                             <xref linkend="Datatype_RFILE_f">Types de données</xref>
51                         </para>
52                     </listitem>
53                     <listitem>
54                         <para>
55                             <xref linkend="Dialogbox_RFILE_f">Boîte de dialogue</xref>
56                         </para>
57                     </listitem>
58                     <listitem>
59                         <para>
60                             <xref linkend="Defaultproperties_RFILE_f">Propriétés par défaut</xref>
61                         </para>
62                     </listitem>
63                     <listitem>
64                         <para>
65                             <xref linkend="Example_RFILE_f">Example</xref>
66                         </para>
67                     </listitem>
68                     <listitem>
69                         <para>
70                             <xref linkend="Interfacingfunction_RFILE_f">Fonction d'interfaçage</xref>
71                         </para>
72                     </listitem>
73                     <listitem>
74                         <para>
75                             <xref linkend="Computationalfunction_RFILE_f">Fonction de calcul</xref>
76                         </para>
77                     </listitem>
78                     <listitem>
79                         <para>
80                             <xref linkend="Seealso_RFILE_f">Voir aussi</xref>
81                         </para>
82                     </listitem>
83                 </itemizedlist>
84             </listitem>
85         </itemizedlist>
86     </refsection>
87     <refsection id="Palette_RFILE_f">
88         <title>Palette</title>
89         <itemizedlist>
90             <listitem>
91                 <para>
92                     <link linkend="Sources_pal">Sources </link>
93                 </para>
94             </listitem>
95         </itemizedlist>
96     </refsection>
97     <refsection id="Description_RFILE_f">
98         <title>Description</title>
99         <para>
100             Ce bloc permet à l'utilisateur de lire des données dans un fichier avec le nom défini par la chaîne <emphasis role="bold">Input File Name</emphasis> en mode texte formatté ou en mode binaire.
101         </para>
102         <para>
103             Le fichier est une séquence d'enregistrements. Chaque enregistrement a une longueur <emphasis role="bold">Record Size</emphasis> et la structure ci-dessous :
104         </para>
105         <mediaobject>
106             <imageobject>
107                 <imagedata fileref="../../../images/palettes/sources_pal/fr_FR/rfile_f_record_fr_FR.gif"/>
108             </imageobject>
109             <textobject>
110                 <programlisting role="pic"><![CDATA[
111 .PS
112 box "Champ #1";
113 box "Champ #2";
114 box "...";
115 box "Champ #(N-1)";
116 box "Champ #N";
117 .PE
118                 ]]></programlisting>
119             </textobject>
120         </mediaobject>
121         <para>
122             Le paramètre <emphasis role="bold">Time record Selection</emphasis> permet à l'utilisateur de sélectionner un champ de l'enregistrement qui représente des événements
123             temporels. Quand ce paramètre est fourni, une sortie d'activation est ajoutée au block qui renvoie ces événements à l'utilisateur. Vous pouvez effectuer un bouclage
124             de la sortie d'activation sur l'entrée d'événement du bloc pour lire les enregistrements en séquence jusqu'à la fin du fichier comme dans l'exemple ci-dessous.
125         </para>
126         <para>
127             Le paramètre  <emphasis role="bold">Output record selection</emphasis> est utilisé pour sélectionner les champs de l'enregistrement qui sont inclus dans la sortie régulière.
128         </para>
129         <para>
130             Le paramètre <emphasis role="bold">Output Format</emphasis> donne le format d'un enregistrement.
131         </para>
132         <itemizedlist>
133             <listitem>
134                 <para>Pour un fichier binaire, ce paramètre est vide.</para>
135             </listitem>
136             <listitem>
137                 <para>Pour un fichier texte, ce paramètre est une chaîne de format (syntaxe Fortran) entre parenthèses.</para>
138             </listitem>
139         </itemizedlist>
140         <para>Chaque appel au bloc avance d'un enregistrement dans le fichier.</para>
141     </refsection>
142     <refsection id="Datatype_RFILE_f">
143         <title>Types de données</title>
144         <itemizedlist>
145             <listitem>
146                 <para>
147                     Sortie: un scalaire ou un vecteur colonne de données de type double. La longueur du vecteur est égale à la longueur du vecteur 
148                     <emphasis role="bold">Outputs Record Selection</emphasis>.
149                 </para>
150             </listitem>
151         </itemizedlist>
152     </refsection>
153     <refsection id="Dialogbox_RFILE_f">
154         <title>Boîte de dialogue</title>
155         <para>
156             <inlinemediaobject>
157                 <imageobject>
158                     <imagedata fileref="../../../gui/sources_pal/fr_FR/RFILE_f_gui.png" align="center"/>
159                 </imageobject>
160             </inlinemediaobject>
161         </para>
162         <para>
163         </para>
164         <itemizedlist>
165             <listitem>
166                 <para>
167                     <emphasis role="bold">Time Record Selection</emphasis>
168                 </para>
169                 <para> Une matrice vide ou un entier positif.</para>
170                 <para>
171                     Si un entier 
172                     <emphasis>
173                         <literal>i</literal>
174                     </emphasis>
175                     est donné, le 
176                     <emphasis><literal>
177                             i<superscript>ième</superscript>
178                         </literal>
179                     </emphasis>
180                     élément de l'enregistrement lu
181                     est supposée être la date de l'événement de sortie.
182                 </para>
183                 <para>Si c'est une matrice vide, il n'existe aucun évènement de sortie.</para>
184                 <para> Propriétés : Type 'vec' de taille -1. </para>
185             </listitem>
186             <listitem>
187                 <para>
188                     <emphasis role="bold">Outputs Record Selection</emphasis>
189                 </para>
190                 <para>
191                     Un vecteur d'entiers positifs 
192                     <emphasis><literal>
193                             [k<subscript>i</subscript>,...,k<subscript>n</subscript>]
194                         </literal>
195                     </emphasis>
196                     le 
197                     <emphasis><literal>
198                             k<subscript>i</subscript><superscript>ième</superscript>
199                         </literal>
200                     </emphasis>
201                     élément 
202                     de l'enregistrement lu donne la valeur de la 
203                     <emphasis><literal>
204                             i<superscript>ième</superscript>
205                         </literal>
206                     </emphasis>
207                     sortie.
208                 </para>
209                 <para> Propriétés : Type 'vec' de taille -1.</para>
210             </listitem>
211             <listitem>
212                 <para>
213                     <emphasis role="bold">Input File Name</emphasis>
214                 </para>
215                 <para>
216                     Une chaîne de caractères définissant le chemin du fichier. Le bloc supporte l'expansion de nom de fichier et vous pouvez utiliser les variables d'environment
217                     comme <emphasis>PWD</emphasis> dans le chemin, par exemple <emphasis>"PWD/my_data/"</emphasis>. Sans spécificateur de chemin, le fichier est lu dans le
218                     répertoire défini par la variable <emphasis>PWD</emphasis>.
219                 </para>
220                 <para>Le fichier doit exister sinon vous obtiendrez un message d'erreur.</para>
221                 <para> Propriétés : Type 'str' de taille 1. </para>
222             </listitem>
223             <listitem>
224                 <para>
225                     <emphasis role="bold">Input Format</emphasis>
226                 </para>
227                 <para>
228                     Une chaîne de caractères définissant le format Fortran à utiliser ou rien pour une lecture non formatée (binaire).
229                     S'il est donné, le format doit commencer par une parenthèse gauche et se terminer par une parenthèse droite.Par exemple : 
230                     <emphasis>
231                         <literal>(10e3)</literal>
232                     </emphasis>
233                 </para>
234                 <para> Propriétés : Type 'str' de taille 1. </para>
235             </listitem>
236             <listitem>
237                 <para>
238                     <emphasis role="bold">Buffer Size</emphasis>
239                 </para>
240                 <para>
241                     Pour une meilleure efficacité, il est possible de mettre les données en mémoire tampon. La lecture des échantillons sur le périphérique remplit la mémoire tampon pour qu'il
242                     y ait toujours des données disponibles en mémoire pour le bloc.
243                 </para>
244                 <para> Propriétés : Type 'vec' de taille 1.</para>
245             </listitem>
246         </itemizedlist>
247     </refsection>
248     <refsection id="Defaultproperties_RFILE_f">
249         <title>Propriétés par défaut</title>
250         <itemizedlist>
251             <listitem>
252                 <para>
253                     <emphasis role="bold">always active:</emphasis> non
254                 </para>
255             </listitem>
256             <listitem>
257                 <para>
258                     <emphasis role="bold">direct-feedthrough:</emphasis> non
259                 </para>
260             </listitem>
261             <listitem>
262                 <para>
263                     <emphasis role="bold">zero-crossing:</emphasis> non
264                 </para>
265             </listitem>
266             <listitem>
267                 <para>
268                     <emphasis role="bold">mode:</emphasis> non
269                 </para>
270             </listitem>
271             <listitem>
272                 <para>
273                     <emphasis role="bold">regular outputs:</emphasis>
274                 </para>
275                 <para>
276                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
277                 </para>
278             </listitem>
279             <listitem>
280                 <para>
281                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
282                 </para>
283             </listitem>
284             <listitem>
285                 <para>
286                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
287                 </para>
288             </listitem>
289             <listitem>
290                 <para>
291                     <emphasis role="bold">continuous-time state:</emphasis> non
292                 </para>
293             </listitem>
294             <listitem>
295                 <para>
296                     <emphasis role="bold">discrete-time state:</emphasis> oui
297                 </para>
298             </listitem>
299             <listitem>
300                 <para>
301                     <emphasis role="bold">object discrete-time state:</emphasis> non
302                 </para>
303             </listitem>
304             <listitem>
305                 <para>
306                     <emphasis role="bold">name of computational function:</emphasis>
307                     <emphasis role="italic">readf</emphasis>
308                 </para>
309             </listitem>
310         </itemizedlist>
311     </refsection>
312     <refsection id="Example_RFILE_f">
313         <title>Exemple</title>
314         <para>
315             Cet exemple lit le fichier : <emphasis>"SCI/modules/xcos/examples/sources_pal/fr_FR/rfile_f.txt"</emphasis> qui contient un jeu de données généré par l'exemple de la page
316             d'aide de <link linkend="WFILE_f">WFILE_f</link>.
317         </para>
318         <para>
319             Il utilise sa sortie d'activation comme entrée de CSCOPE. Dans le fichier, le premier champ de l'enregistrement est le temps, les deux autres sont des données régulières.
320             Le bouclage de la sortie d'activation sur l'entrée d'activation assure la lecture séquentielle du fichier.
321         </para>
322         <para>
323             <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/fr_FR/rfile_f_fr_FR.zcos">
324                 <inlinemediaobject>
325                     <imageobject>
326                         <imagedata align="center" fileref="../../../../examples/sources_pal/fr_FR/rfile_f_fr_FR.zcos" valign="middle"/>
327                     </imageobject>
328                 </inlinemediaobject>
329             </link>
330         </para>
331     </refsection>
332     <refsection id="Interfacingfunction_RFILE_f">
333         <title>Fonction d'interfaçage</title>
334         <itemizedlist>
335             <listitem>
336                 <para>
337                     <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/RFILE_f.sci">SCI/modules/scicos_blocks/macros/Sources/RFILE_f.sci</link>
338                 </para>
339             </listitem>
340         </itemizedlist>
341     </refsection>
342     <refsection id="Computationalfunction_RFILE_f">
343         <title>Fonction de calcul</title>
344         <itemizedlist>
345             <listitem>
346                 <para> SCI/modules/scicos_blocks/src/fortran/readf.f (Type 0)</para>
347             </listitem>
348         </itemizedlist>
349     </refsection>
350     <refsection role="see also" id="Seealso_RFILE_f">
351         <title>Voir aussi</title>
352         <itemizedlist>
353             <listitem>
354                 <link linkend="READC_f">READC_f</link>
355             </listitem>
356             <listitem>
357                 <link linkend="WRITEC_f">WRITEC_f</link>
358             </listitem>
359             <listitem>
360                 <link linkend="WFILE_f">WFILE_f</link>
361             </listitem>
362         </itemizedlist>
363     </refsection>
364 </refentry>