* Bug #8290 fixed - Documented the DELAYV_f block. 95/14095/2
Paul Bignier [Fri, 21 Mar 2014 10:42:10 +0000 (11:42 +0100)]
Change-Id: I42f6c51e42435de5398fa468493f72cc43425d18

scilab/CHANGES_5.5.X
scilab/modules/helptools/etc/images_md5.txt
scilab/modules/helptools/images/DELAYV_f_1.png [new file with mode: 0644]
scilab/modules/helptools/images/DELAYV_f_en_US.zcos.png [new file with mode: 0644]
scilab/modules/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos [new file with mode: 0644]
scilab/modules/xcos/examples/discrete_pal/en_US/DELAY_f_1_en_US.zcos
scilab/modules/xcos/help/en_US/palettes/Discrete_pal/DELAYV_f.xml
scilab/modules/xcos/help/fr_FR/palettes/Discrete_pal/DELAYV_f.xml

index a97b1b3..e3d5c29 100644 (file)
@@ -335,6 +335,8 @@ Scilab Bug Fixes
 
 * Bug #8247 fixed - regress tagged as obsolete.
 
+* Bug #8290 fixed - Documented the DELAYV_f block.
+
 * Bug #8323 fixed - Scilab "About Box" did not hide Scilab main window.
 
 * Bug #8337 fixed - mtlb_rand now uses the "uniform" rule, whatever the random rule set is.
index bc2ed08..1c73678 100644 (file)
@@ -45,6 +45,7 @@ CSCOPE_1.png=2d909fe2bcc644ed0330ec8bbb0318d2
 Counter_1.png=a88328a6ccb0eccd4ed8bf4a5bbb82ee
 DEADBAND_1.png=20a32eccd368a2c1db61d29c84129eff
 DEADBAND_fr_FR_1.png=1d45f2e6ad98c824be4205cb4f5ea1e1
+DELAYV_f_1.png=f0c432cadcd045273269e52b87199ec7
 DELAY_f_1.png=6965e321be950bc9529fc67c3177d0a7
 DELAY_f_2.png=b10b9eb56f4f302b40722fc37f90152
 DELAY_f_fr_FR_1.png=c3059f389f1c116fb8149b96baa3817
diff --git a/scilab/modules/helptools/images/DELAYV_f_1.png b/scilab/modules/helptools/images/DELAYV_f_1.png
new file mode 100644 (file)
index 0000000..6e2c832
Binary files /dev/null and b/scilab/modules/helptools/images/DELAYV_f_1.png differ
diff --git a/scilab/modules/helptools/images/DELAYV_f_en_US.zcos.png b/scilab/modules/helptools/images/DELAYV_f_en_US.zcos.png
new file mode 100644 (file)
index 0000000..947444e
Binary files /dev/null and b/scilab/modules/helptools/images/DELAYV_f_en_US.zcos.png differ
diff --git a/scilab/modules/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos b/scilab/modules/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos
new file mode 100644 (file)
index 0000000..22e451a
Binary files /dev/null and b/scilab/modules/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos differ
index ea385bf..ccc9f8e 100644 (file)
Binary files a/scilab/modules/xcos/examples/discrete_pal/en_US/DELAY_f_1_en_US.zcos and b/scilab/modules/xcos/examples/discrete_pal/en_US/DELAY_f_1_en_US.zcos differ
index feda3a3..ef00f6e 100644 (file)
@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scicos
- * 
+ *
  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  *  (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
+ *
  * See the file ./license.txt
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="DELAYV_f">
     </refsection>
     <refsection id="Description_DELAYV_f">
         <title>Description</title>
-        <para>Add here a paragraph of the function description</para>
-        <para/>
+        <para>
+            The Variable Delay block can be used to simulate a variable time delay
+            between an action and its effect. The block might be used, for example,
+            to model a system with a pipe where the speed of a motor pumping fluid in the pipe is variable.
+        </para>
+        <para>
+            The block accepts two inputs and one output: the first input
+            is the signal u(t) that passes through the block (data input);
+            the second input is the variable time delay τ(t).
+        </para>
+        <para>
+            The ouput activation ports trigger every
+            <literal>"Max delay"/length("Register initial condition")</literal>.
+        </para>
+        <para>
+            The input activation port and the first ouput activation port are meant to be linked,
+            to get the variations of the input.
+        </para>
+        <para>
+            The final delay is: <literal>τ(t) + "Max delay"/length("Register initial condition")</literal>.
+        </para>
     </refsection>
     <refsection id="Dialogbox_DELAYV_f">
         <title>Dialog box</title>
             </listitem>
         </itemizedlist>
     </refsection>
+    <refsection id="Example_DELAYV_f">
+        <title>Variable delay example</title>
+        <para>
+            In this example, the sine function (in black) est delayed alternatively by 0 and 1 second.
+            The amplitude of the GENSQR_f block is fixed at 2, but the "Max delay" parameter of the
+            DELAVV_f block restrains that value to 1.
+            We see that with every time GENSQR_f is activated (every 2*π seconds), the delay changes:
+            the curves overlap (delay=0) and are shifted (delay=1) in turn.
+        </para>
+        <link type="scilab" linkend="scilab.xcos/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos">
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata align="center" fileref="../../../../examples/discrete_pal/en_US/DELAYV_f_en_US.zcos" valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
+        </link>
+        <scilab:image><![CDATA[
+importXcosDiagram(SCI + "/modules/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos");
+xcos_simulate(scs_m, 4);
+]]></scilab:image>
+    </refsection>
 </refentry>
index 4b4b50f..471de7f 100644 (file)
     </refsection>
     <refsection id="Description_DELAYV_f">
         <title>Description</title>
-        <para>Ajouter un paragraphe de description de la fonction ici</para>
-        <para/>
+        <para>
+            Le bloc Délai variable peut être utilisé pour simuler un délai variable
+            entre une action et son effet. Le bloc est utilisé, par exemple, pour modéliser
+            un système avec un tube où la vitesse de pompage du fluide dans le tube est variable.
+        </para>
+        <para>
+            Le bloc accepte deux entrées et une sortie : la première entrée est le
+            signal u(t) qui passe à travers le bloc (entrée de donnée); la seconde entrée
+            est le temps de retard variable τ(t).
+        </para>
+        <para>
+            Les ports de sortie d'activiation se déclenchent tous les
+            <literal>"Max delay"/length("Register initial condition")</literal>.
+        </para>
+        <para>
+            The input activation port and the first ouput activation port are meant to be linked,
+            to get the variations of the input.
+        </para>
+        <para>
+            Le délai final est : <literal>τ(t) + "Max delay"/length("Register initial condition")</literal>.
+        </para>
     </refsection>
     <refsection id="Dialogbox_DELAYV_f">
         <title>Boîte de dialogue</title>
             </listitem>
         </itemizedlist>
     </refsection>
+    <refsection id="Example_DELAYV_f">
+        <title>Exemple de délai variable</title>
+        <para>
+            Dans cet exemple, la fonction sinus (en noir) est retardée alternativement de 0 et 1 seconde.
+            L'amplitude du bloc GENSQR_f est fixée à 2, mais le paramètre "Max delay" du bloc DELAVV_f
+            bride cette valeur à 1.
+            On voit qu'à chaque fois que GENSQR_f est activé (toutes les 2*π secondes), le délai change :
+            tour à tour, les courbes se superposent (délai=0) et sont décalées (délai=1).
+        </para>
+        <link type="scilab" linkend="scilab.xcos/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos">
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata align="center" fileref="../../../../examples/discrete_pal/en_US/DELAYV_f_en_US.zcos" valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
+        </link>
+        <scilab:image><![CDATA[
+importXcosDiagram(SCI + "/modules/xcos/examples/discrete_pal/en_US/DELAYV_f_en_US.zcos");
+xcos_simulate(scs_m, 4);
+]]></scilab:image>
+    </refsection>
 </refentry>