* Bug #13385 fixed - TOWS_c and FROMWSB Xcos blocs needed better examples on how... 09/14509/2
Pierre-Aime Agnel [Tue, 6 May 2014 14:09:39 +0000 (16:09 +0200)]
Change-Id: I57a21b0a92a13ad78ca48fffda3ed47521372a31

scilab/CHANGES_5.5.X
scilab/modules/helptools/images/FROMWSB_en_US.zcos.png [new file with mode: 0644]
scilab/modules/helptools/images/TOWS_c_Example.zcos.png
scilab/modules/xcos/examples/sinks_pal/TOWS_c_Example.zcos
scilab/modules/xcos/examples/sources_pal/en_US/FROMWSB_en_US.zcos [new file with mode: 0644]
scilab/modules/xcos/help/en_US/palettes/Sinks_pal/TOWS_c.xml
scilab/modules/xcos/help/en_US/palettes/Sources_pal/FROMWSB.xml

index be96d6f..7b24e5f 100644 (file)
@@ -26,10 +26,14 @@ Scilab Bug Fixes
 Xcos Bug Fixes
 ==============
 
-* Bug #9996 fixed - The RELATION_OP box drawn in the work space is not compliant to the programming.
+* Bug #9996 fixed - The RELATION_OP box drawn in the work space is not compliant
+                    to the programming.
 
 * Bug #12751 fixed - cdummy_ entry point was not found when using Code Generation.
 
+* Bug #13385 fixed - TOWS_c and FROMWSB Xcos blocs needed better examples on how
+                     to get or write a Scilab variable.
+
 
                      Changes between version 5.4.1 and 5.5.0
                      =======================================
diff --git a/scilab/modules/helptools/images/FROMWSB_en_US.zcos.png b/scilab/modules/helptools/images/FROMWSB_en_US.zcos.png
new file mode 100644 (file)
index 0000000..a594564
Binary files /dev/null and b/scilab/modules/helptools/images/FROMWSB_en_US.zcos.png differ
index 7f455e3..fd3bcd1 100644 (file)
Binary files a/scilab/modules/helptools/images/TOWS_c_Example.zcos.png and b/scilab/modules/helptools/images/TOWS_c_Example.zcos.png differ
index e561abd..d21371e 100644 (file)
Binary files a/scilab/modules/xcos/examples/sinks_pal/TOWS_c_Example.zcos and b/scilab/modules/xcos/examples/sinks_pal/TOWS_c_Example.zcos differ
diff --git a/scilab/modules/xcos/examples/sources_pal/en_US/FROMWSB_en_US.zcos b/scilab/modules/xcos/examples/sources_pal/en_US/FROMWSB_en_US.zcos
new file mode 100644 (file)
index 0000000..9fc3cbe
Binary files /dev/null and b/scilab/modules/xcos/examples/sources_pal/en_US/FROMWSB_en_US.zcos differ
index b92011a..68f5bdb 100644 (file)
         <para>That block is used to put simulated data in the scilab
             workspace.
         </para>
-        <para>Each sampling time, both dates and values of input are
+        <para>
+            Each sampling time, both dates and values of input are
             recorded.
         </para>
+        <para>
+            Records are available after the simulation in Scilab's workspace
+            as <literal>variable.time</literal> and <literal>variable.values</literal>
+            where <literal>variable</literal> is the name given in the
+            <emphasis role="bold">Scilab variable name</emphasis> field.
+        </para>
     </refsection>
     <refsection id="Dialogbox_TOWS_c">
         <title>Dialog box</title>
index 282711e..951afdc 100644 (file)
                         </para>
                         <latex>
                             $$
-                            S^(2) (x_1) = 0
-                            \vdots
-                            S^(2) (x_n) = 0
+                            S^{(2)} (x_1) = 0 \\
+                            \vdots \\
+                            S^{(2)} (x_n) = 0 \\
                             $$
                         </latex>
                         <para>This method is only available for Real and complex data types.
                         </para>
                         <latex>
                             $$
-                            S^(3) (x_2^-) = S^(3) (x_2^+)
-                            \vdots
-                            S^(3) (x_{n-1}^-) = S^(3) (x_{n-1}^+)
+                            S^{(3)} (x_2^-) = S^{(3)} (x_2^+) \\
+                            \vdots \\
+                            S^{(3)} (x_{n-1}^-) = S^{(3)} (x_{n-1}^+) \\
                             $$
                         </latex>
-                        <para>This method is only available for Real and complex data types.
+                        <para>This method is only available for Real and Complex data types.
                         </para>
                     </listitem>
                 </itemizedlist>
             </listitem>
         </itemizedlist>
     </refsection>
+    <refsection id="Example_FROMWSB">
+        <title>Example</title>
+        <programlisting role="example"><![CDATA[ 
+            // Create the variable to load from
+            V.time = (1:1000)'; //the values must be on a column vector
+            V.values = cos(2* %pi * V.time / 20); 
+            ]]></programlisting>
+        <para>
+            <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/FROMWSB_en_US.zcos">
+                <inlinemediaobject>
+                    <imageobject>
+                        <imagedata align="center" fileref="../../../../examples/sources_pal/en_US/FROMWSB_en_US.zcos" valign="middle"/>
+                    </imageobject>
+                </inlinemediaobject>
+            </link>
+        </para>
+    </refsection>
     <refsection id="Seealso_FROMWSB">
         <title>See also</title>
         <itemizedlist>