Xcos help: fixed the simulation time, resized images, deleted unused links.
[scilab.git] / scilab / modules / xcos / help / fr_FR / palettes / Sinks_pal / WRITEC_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
14   xmlns:scilab="http://www.scilab.org" xml:id="WRITEC_f" xml:lang="fr_FR"
15   xmlns="http://docbook.org/ns/docbook"
16   xmlns:xlink="http://www.w3.org/1999/xlink"
17   xmlns:svg="http://www.w3.org/2000/svg"
18   xmlns:ns5="http://www.w3.org/1999/xhtml"
19   xmlns:mml="http://www.w3.org/1998/Math/MathML"
20   xmlns:db="http://docbook.org/ns/docbook"
21 >
22     <refnamediv>
23         <refname>WRITEC_f</refname>
24         <refpurpose>Ecriture dans une fichier binaire C</refpurpose>
25     </refnamediv>
26     
27     <refsection>
28         <title>Aperçu</title>
29         <para>
30             <inlinemediaobject>
31                 <imageobject>
32                     <imagedata fileref="../../../../images/palettes/WRITEC_f.png" align="center" valign="middle"/>
33                 </imageobject>
34             </inlinemediaobject>
35         </para>
36     </refsection>
37     <refsection id="Contents_WRITEC_f">
38         <title>Contenu</title>
39         <itemizedlist>
40             <listitem>
41                 <para>
42                     <link linkend="WRITEC_f">Ecriture dans une fichier binaire C</link>
43                 </para>
44             </listitem>
45             <listitem>
46                 <itemizedlist>
47                     <listitem>
48                         <para>
49                             <xref linkend="Palette_WRITEC_f">Palette</xref>
50                         </para>
51                     </listitem>
52                     <listitem>
53                         <para>
54                             <xref linkend="Description_WRITEC_f">Description</xref>
55                         </para>
56                     </listitem>
57                     <listitem>
58                         <para>
59                             <xref linkend="Datatype_WRITEC_f">Types de données</xref>
60                         </para>
61                     </listitem>
62                     <listitem>
63                         <para>
64                             <xref linkend="Dialogbox_WRITEC_f">Boîte de dialogue</xref>
65                         </para>
66                     </listitem>
67                     <listitem>
68                         <para>
69                             <xref linkend="Defaultproperties_WRITEC_f">Propriétés par défaut</xref>
70                         </para>
71                     </listitem>
72                     <listitem>
73                         <para>
74                             <xref linkend="Example_WRITEC_f">Exemple</xref>
75                         </para>
76                     </listitem>
77                     <listitem>
78                         <para>
79                             <xref linkend="Interfacingfunction_WRITEC_f">Fonction d'interfaçage</xref>
80                         </para>
81                     </listitem>
82                     <listitem>
83                         <para>
84                             <xref linkend="Computationalfunction_WRITEC_f">Fonction de calcul</xref>
85                         </para>
86                     </listitem>
87                     <listitem>
88                         <para>
89                             <xref linkend="Seealso_WRITEC_f">Voir aussi</xref>
90                         </para>
91                     </listitem>
92                 </itemizedlist>
93             </listitem>
94         </itemizedlist>
95     </refsection>
96     
97     <refsection id="Palette_WRITEC_f">
98         <title>Palette</title>
99         <itemizedlist>
100             <listitem>
101                 <para>
102                     <link linkend="Sinks_pal">Palette Sinks</link>
103                 </para>
104             </listitem>
105         </itemizedlist>
106     </refsection>
107     
108     <refsection id="Description_WRITEC_f">
109         <title>Description</title>
110         
111         <para>
112             Ce  bloc permet à l'utilisateur d'écrire des données dans un fichier binaire C dont le nom est défini par la chaîne  <emphasis role="bold">Output File Name</emphasis>. Le fichier est une séquence
113             d'enregistrements. Chaque enregistrement a une longueur fixée par le paramètre <emphasis role="bold">Input Size</emphasis> et la structure ci-dessous :
114         </para>
115         <mediaobject>
116             <imageobject>
117                 <imagedata fileref="../../../images/palettes/sinks_pal/fr_FR/writec_f_record_fr_FR.gif"/>
118             </imageobject>
119             <textobject>
120                 <programlisting role="pic"><![CDATA[
121 .PS
122 box "Champ #1";
123 box "Champ #2";
124 box "...";
125 box "Champ #(N-1)";
126 box "Champ #N";
127 .PE
128                 ]]></programlisting>
129             </textobject>
130         </mediaobject>
131         <para>où les entrées du bloc sont numérotées de haut en bas.</para>
132         <para>
133             Les champs de l'enregistrement doivent contenir des données de même type défini par le paramètre <emphasis role="bold">Output Format</emphasis>.
134         </para>
135         <para>
136             Chaque événement sur l'entrée d'activation du bloc écrit un enregistrement dans le fichier. Notez que contrairement à <link linkend="WFILE_f">WFILE_f</link>, les dates d'événement
137             ne sont pas enregistrées.
138         </para>
139     </refsection>
140     
141     <refsection id="Datatype_WRITEC_f">
142         <title>Types de données</title>
143         <itemizedlist>
144             <listitem>
145                 <para>
146                     Entrée : un scalaire ou un vecteur colonne de longueur <emphasis role="bold">Input Size</emphasis>.
147                 </para>
148             </listitem>
149         </itemizedlist>
150     </refsection>
151     
152     <refsection id="Dialogbox_WRITEC_f">
153         <title>Boîte de dialogue</title>
154         <para>
155             <inlinemediaobject>
156                 <imageobject>
157                     <imagedata fileref="../../../gui/sinks_pal/fr_FR/WRITEC_f_gui.png" align="center" valign="middle"/>
158                 </imageobject>
159             </inlinemediaobject>
160         </para>
161         <para />
162         <itemizedlist>
163             <listitem>
164                 <para>
165                     <emphasis role="bold">Input Size</emphasis>
166                 </para>
167                 <para> Un scalaire, la longueur du vecteur d'entrée.</para>
168                 <para> Propriétés : Type 'vec' de taille 1 </para>
169             </listitem>
170             <listitem>
171                 <para>
172                     <emphasis role="bold">Output File Name</emphasis>
173                 </para>
174                 <para>
175                     Une chaîne de caractères définissant le chemin du fichier de sortie. Le bloc supporte l'expansion de nom de fichier et vous pouvez
176                     utiliser les variables d'environnement telles que <emphasis>HOME</emphasis> dans le chemin, par exemple
177                     <emphasis>"HOME/mes_donnees/"</emphasis>. Sans spécification de chemin, le fichier est écrit dans le répertoire défini par la variable <emphasis>PWD</emphasis>.
178                 </para>
179                 <para>Le chemin du répertoire doit exister, sinon vous obtiendrez un message d'erreur.</para>
180                 <para> Propriétés : Type 'str' de taille 1 </para>
181             </listitem>
182             <listitem>
183                 <para>
184                     <emphasis role="bold">Output Format</emphasis>
185                 </para>
186                 <para>
187                     Une chaîne de caractères définissant le format à utiliser. Les chaînes suivantes "l", "i", "s", "ul", "ui", "us", "d", "f", "c", "uc"
188                     sont respectivement utilisées pour écrire des données de type int32, int16, int8, unit32, uint16, uint8, double,
189                     float, char and uchar.
190                 </para>
191                 <para>
192                     Vous devez utiliser le même format quand vous lisez le fichier avec <link linkend="READC_f">READC_f</link>.
193                 </para>
194                 <para> Propriétés : Type 'str' de taille 1 </para>
195             </listitem>
196             <listitem>
197                 <para>
198                     <emphasis role="bold">Buffer Size</emphasis>
199                 </para>
200                 <para>
201                     Pour une meilleure efficacité, il est possible de mettre en tampon mémoire les données d'entrée. Les écritures de données sur le fichier ne sont effectuées que si
202                     le tampon est plein ou à la fin de la simulation.
203                 </para>
204                 <para> Propriétés : Type 'vec' de taille 1 </para>
205             </listitem>
206             <listitem>
207                 <para>
208                     <emphasis role="bold">Swap Mode (0:No, 1:Yes)</emphasis>
209                 </para>
210                 <para>Endian IEEE format</para>
211                 <itemizedlist>
212                     <listitem>
213                         <para>
214                             <emphasis role="bold">0</emphasis> : l'échange automatique est ignoré.
215                         </para>
216                     </listitem>
217                     <listitem>
218                         <para>
219                             <emphasis role="bold">1</emphasis> : le fichier est supposé être codé en format  "little endian IEEE". L'octet de poids le plus fort et l'octet de poids le plus faible
220                             sont échangés si nécessaire pour être conforme avec le format IEEE du processeur.
221                         </para>
222                     </listitem>
223                 </itemizedlist>
224                 <para> Propriétés : Type 'vec' de taille 1 </para>
225             </listitem>
226         </itemizedlist>
227     </refsection>
228     
229     <refsection id="Defaultproperties_WRITEC_f">
230         <title>Propriétés par défaut</title>
231         <itemizedlist>
232             <listitem>
233                 <para>
234                     <emphasis role="bold">always active:</emphasis> non
235                 </para>
236             </listitem>
237             <listitem>
238                 <para>
239                     <emphasis role="bold">direct-feedthrough:</emphasis> oui
240                 </para>
241             </listitem>
242             <listitem>
243                 <para>
244                     <emphasis role="bold">zero-crossing:</emphasis> non
245                 </para>
246             </listitem>
247             <listitem>
248                 <para>
249                     <emphasis role="bold">mode:</emphasis> non
250                 </para>
251             </listitem>
252             <listitem>
253                 <para>
254                     <emphasis role="bold">regular inputs:</emphasis>
255                 </para>
256                 <para>
257                     <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
258                 </para>
259             </listitem>
260             <listitem>
261                 <para>
262                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
263                 </para>
264             </listitem>
265             <listitem>
266                 <para>
267                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
268                 </para>
269             </listitem>
270             <listitem>
271                 <para>
272                     <emphasis role="bold">continuous-time state:</emphasis> non
273                 </para>
274             </listitem>
275             <listitem>
276                 <para>
277                     <emphasis role="bold">discrete-time state:</emphasis> oui
278                 </para>
279             </listitem>
280             <listitem>
281                 <para>
282                     <emphasis role="bold">object discrete-time state:</emphasis> non
283                 </para>
284             </listitem>
285             <listitem>
286                 <para>
287                     <emphasis role="bold">name of computational function:</emphasis>
288                     <emphasis role="italic">writec</emphasis>
289                 </para>
290             </listitem>
291         </itemizedlist>
292     </refsection>
293     
294     <refsection id="Example_WRITEC_f">
295         <title>Exemple</title>
296         <para>
297             Dans cet exemple le bloc est utilisé pour enregistrer la sortie du générateur sinusoïdal. Pour enregistrer en même temps
298             les dates des événements, nous utilisons un bloc TIME_f et un multiplexeur pour former le vecteur d'entrée du bloc WRITEC_f
299             qui enregistre les données dans le fichier <emphasis>"TMPDIR/writec_f.datas"</emphasis>. Vous pouvez ensuite lire les ces
300             données avec le bloc <link linkend="READC_f">READC_f</link>.
301         </para>
302         <para>
303             <link type="scilab" linkend="scilab.xcos/xcos/examples/sinks_pal/fr_FR/writec_f_fr_FR.zcos">
304                 <inlinemediaobject>
305                     <imageobject>
306                         <imagedata align="center" fileref="../../../../examples/sinks_pal/fr_FR/writec_f_fr_FR.zcos" valign="middle"/>
307                     </imageobject>
308                 </inlinemediaobject>
309             </link>
310         </para>
311     </refsection>
312     
313     <refsection id="Interfacingfunction_WRITEC_f">
314         <title>Fonction d'interfaçage</title>
315         <itemizedlist>
316             <listitem>
317                 <para>
318                     <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sinks/WRITEC_f.sci">SCI/modules/scicos_blocks/macros/Sinks/WRITEC_f.sci</link>
319                 </para>
320             </listitem>
321         </itemizedlist>
322     </refsection>
323     
324     <refsection id="Computationalfunction_WRITEC_f">
325         <title>Fonction de calcul</title>
326         <itemizedlist>
327             <listitem>
328                 <para> SCI/modules/scicos_blocks/src/c/writec.c (Type 2)</para>
329             </listitem>
330         </itemizedlist>
331     </refsection>
332     
333     <refsection role="see also" id="Seealso_WRITEC_f">
334         <title>Voir aussi</title>
335         <itemizedlist>
336             <listitem>
337                 <link linkend="READC_f">READC_f</link>
338             </listitem>
339             <listitem>
340                 <link linkend="RFILE_f">RFILE_f</link>
341             </listitem>
342             <listitem>
343                 <link linkend="WFILE_f">WFILE_f</link>
344             </listitem>
345         </itemizedlist>
346     </refsection>
347 </refentry>