* Bug 14425 fixed - xpause() set obsolete, merged in sleep(). sleep(,'s') implemented
[scilab.git] / scilab / modules / time / help / fr_FR / sleep.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) INRIA -
5  * Copyright (C) 2016 - Samuel GOUGEON
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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:lang="fr" xml:id="sleep">
17     <refnamediv>
18         <refname>sleep</refname>
19         <refpurpose>mise en sommeil de l'interprêteur (console, scripts, callbacks)</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntaxe</title>
23         <synopsis>
24             sleep(milliseconds)
25             sleep(seconds, "s")
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection role="arguments">
29         <title>Paramètres</title>
30         <variablelist>
31             <varlistentry>
32                 <term>milliseconds</term>
33                 <listitem>Durée du sommeil, en millisecondes (nombre décimal)
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>seconds</term>
38                 <listitem>Durée du sommeil, en secondes (nombre décimal)
39                 </listitem>
40             </varlistentry>
41         </variablelist>
42     </refsection>
43     <refsection>
44         <title>Description</title>
45         <para>
46             <literal>sleep</literal> arrête l'exécution des instructions Scilab
47             et attend la durée spécifiée, sans rien faire (ou presque):
48             <variablelist>
49                 <varlistentry>
50                     <term>Console :</term>
51                     <listitem> les entrées et affichages sont suspendus.
52                         <warning>L'interruption avec CTRL-C est prise en compte mais
53                             est exécutée uniquement au terme de la période de sommeil
54                             programmée.
55                         </warning>
56                     </listitem>
57                 </varlistentry>
58                 <varlistentry>
59                     <term>Scripts et functions :</term>
60                     <listitem>
61                          lorsque <function>sleep(..)</function>
62                         est appelée depuis un script ou une function, Scilab attend
63                         la durée indiquée avant d'exécuter la ligne d'instruction suivante
64                         dans le script ou la function. Pendant ce temps, la console
65                         est bloquée. L'interruption CTRL-C est prise en compte mais
66                         exécutée uniquement au terme du sommeil programmé.
67                     </listitem>
68                 </varlistentry>
69                 <varlistentry>
70                     <term>callbacks :</term>
71                     <listitem> .. ce sont les actions programmées à exécuter
72                         lorsqu'on interagit avec les menus et les composants graphiques
73                         interactifs <literal>uicontrol</literal>. Durant le sommeil
74                         provoqué par sleep(..), les interactions avec les menus et les
75                         <literal>uicontrol</literal> sont possibles : les
76                         instructions/actions associées sont prises en compte et mémorises,
77                         mais leur exécution est différée au terme du sommeil.
78                     </listitem>
79                 </varlistentry>
80                 <varlistentry>
81                     <term>Interactions graphiques :</term>
82                     <listitem>
83                         <function>sleep(..)</function>
84                         n'empêche pas les interactions avec les graphiques (courbes,
85                         titres,...), pour peu que le mode graphique interactif soit activé
86                         avant la mise en sommeil.
87                         Il est alors possible de déplacer les courbes, de modifier les
88                         titres des axes, ou d'éditer les points d'une courbe (si cela a
89                         été activé). Le réveil ne remet pas en cause le résultat de ces
90                         actions.
91                     </listitem>
92                 </varlistentry>
93             </variablelist>
94             <note>Résolution temporelle :
95                 <simplelist>
96                     <member>Sous Windows : 0.5 ms</member>
97                     <member>Sous Linux : 1 µs</member>
98                 </simplelist>
99             </note>
100             <warning>Résolution... n'est pas justesse : la durée réelle du sommeil
101                 peut s'avérer différente de la durée spécifiée, en particulier en
102                 fonction de la charge du processeur ou du temps mis par Scilab pour
103                 déclencher <function>sleep()</function>. Voir le test en exemple.
104             </warning>
105         </para>
106     </refsection>
107     <refsection>
108         <title>Exemples</title>
109         <programlisting role="example"><![CDATA[
110 // Exemples simples
111 tic; sleep(4350); toc
112 tic; sleep(4.35, "s"); toc
113
114 // Comparaison entre les durées de sommeil programmée et réelle
115 results = [];
116 disp("SVP patienter... sleep()s et des réveils sont en cours...")
117 for i = -1:4
118     dt = 10^i;        // durée spécifiée [ms]
119     tic;
120     sleep(dt);
121     dta = toc()*1000; // durée réelle mesurée [ms]
122     results = [results ; dt dta ];
123 end
124 results
125
126 // Test d'interruption avec CTRL-C :
127 mprintf("Presser les touches CTRL + C maintenant\n  => pas d''effet : sommeil de 15 s en cours...")
128 sleep(15, "s")
129
130 // Interactions avec les menus : test
131 clf
132 plot2d()
133 // [Si vous êtes utilisateur MacOS, choisir le menu "Editer => Effacer la figure"]
134 mprintf("Pendant ce sommeil de 30s, cliquer sur la fenêtre graphique,\n   puis menu Editer => Propriétés de la Figure")
135 // L'éditeur de propriétés graphiques sera appelé uniquement au réveil de Scilab
136  ]]></programlisting>
137     </refsection>
138     <refsection role="see also">
139         <title>Voir aussi</title>
140         <simplelist type="inline">
141             <member>
142                 <link linkend="pause">pause</link>
143             </member>
144             <member>
145                 <link linkend="halt">halt</link>
146             </member>
147         </simplelist>
148     </refsection>
149     <refsection role="history">
150         <title>Historique</title>
151         <revhistory>
152             <revision>
153                 <revnumber>6.0</revnumber>
154                 <revdescription>
155                     <itemizedlist>
156                         <listitem>Les fractions de millisecondes sont maintenant
157                             acceptées et prises en compte (remplace xpause(microsecondes)).
158                         </listitem>
159                         <listitem>Syntaxe sleep(secondes,"s") ajoutée.
160                         </listitem>
161                     </itemizedlist>
162                 </revdescription>
163             </revision>
164         </revhistory>
165     </refsection>
166 </refentry>
167