Xcos palette: add VirtualCLK0 block 84/7284/4
Clément DAVID [Tue, 29 May 2012 06:26:23 +0000 (08:26 +0200)]
Change-Id: I8c8893fbdbcb0631216443a45faed90b33e808b8

scilab/modules/xcos/etc/Xcos-style.xml
scilab/modules/xcos/etc/palettes.xml
scilab/modules/xcos/help/en_US/palettes/Events_pal/VirtualCLK0.xml [new file with mode: 0644]
scilab/modules/xcos/images/palettes/VirtualCLK0.png [new file with mode: 0644]

index 6b6ab2f..ede9de7 100644 (file)
   <add as="CLOCK_f" extend="Icon">
     <add as="image" value="$SCILAB/modules/xcos/images/blocks/CLOCK_c.svg"/>
   </add>
+  <add as="VirtualCLK0" extend="CLOCK_f"/>
   <add as="CLKSPLIT_f" extend="Split"/>
   <add as="IMPSPLIT_f" extend="Split"/>
   <add as="CLKSOM_f" extend="CLKSOMV_f"/>
index d145a6c..6e94196 100644 (file)
       </block>
     </node>
     <node xsi:type="PreLoaded" enable="true" name="Event handling">
+      <block name="CLOCK_c">
+        <icon variable="SCI" path="/modules/xcos/images/palettes/CLOCK_c.png"/>
+      </block>
+      <block name="SampleCLK">
+        <icon variable="SCI" path="/modules/xcos/images/palettes/SampleCLK.png"/>
+      </block>
+      <block name="VirtualCLK0">
+        <icon variable="SCI" path="/modules/xcos/images/palettes/VirtualCLK0.png"/>
+      </block>
       <block name="ANDBLK">
         <icon variable="SCI" path="/modules/xcos/images/palettes/ANDBLK.png"/>
       </block>
       <block name="CLKSOMV_f">
         <icon variable="SCI" path="/modules/xcos/images/palettes/CLKSOMV_f.png"/>
       </block>
-      <block name="CLOCK_c">
-        <icon variable="SCI" path="/modules/xcos/images/palettes/CLOCK_c.png"/>
-      </block>
       <block name="EDGE_TRIGGER">
         <icon variable="SCI" path="/modules/xcos/images/palettes/EDGE_TRIGGER.png"/>
       </block>
       <block name="MFCLCK_f">
         <icon variable="SCI" path="/modules/xcos/images/palettes/MFCLCK_f.png"/>
       </block>
-      <block name="SampleCLK">
-        <icon variable="SCI" path="/modules/xcos/images/palettes/SampleCLK.png"/>
-      </block>
       <block name="freq_div">
         <icon variable="SCI" path="/modules/xcos/images/palettes/freq_div.png"/>
       </block>
diff --git a/scilab/modules/xcos/help/en_US/palettes/Events_pal/VirtualCLK0.xml b/scilab/modules/xcos/help/en_US/palettes/Events_pal/VirtualCLK0.xml
new file mode 100644 (file)
index 0000000..ff7631b
--- /dev/null
@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) Scilab Enterprises (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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="VirtualCLK0">
+  <refnamediv>
+    <refname>VirtualCLK0</refname>
+    <refpurpose>Triggered Always Active Blocks</refpurpose>
+  </refnamediv>
+  <refsection>
+    <title>Block Screenshot</title>
+    <para>
+      <inlinemediaobject>
+        <imageobject>
+          <imagedata fileref="../../../../images/palettes/VirtualCLK0.png" align="center" valign="middle"/>
+        </imageobject>
+      </inlinemediaobject>
+    </para>
+  </refsection>
+  <refsection id="Contents_VirtualCLK0">
+    <title>Contents</title>
+    <itemizedlist>
+      <listitem>
+        <para>
+          <link linkend="VirtualCLK0">Triggered Always Active Blocks</link>
+        </para>
+      </listitem>
+      <listitem>
+        <itemizedlist>
+          <listitem>
+            <para>
+              <xref linkend="Palette_VirtualCLK0">Palette</xref>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <xref linkend="Description_VirtualCLK0">Description</xref>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <xref linkend="Defaultproperties_VirtualCLK0">Default properties</xref>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <xref linkend="Interfacingfunction_VirtualCLK0">Interfacing function</xref>
+            </para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+    </itemizedlist>
+  </refsection>
+  <refsection id="Palette_VirtualCLK0">
+    <title>Palette</title>
+    <itemizedlist>
+      <listitem>
+        <para>
+          <link linkend="Events_pal">Event handling palette</link>
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsection>
+  <refsection id="Description_VirtualCLK0">
+    <title>Description</title>
+    <para>
+      This block is considered a virtual block by the compilor. It is used in a SuperBlock (subsystem) to trigger the always active blocks (ex: the sinus generator) in the SuperBlock and in the level below. The blocks will be virtually connected to the input of the VirtualCLK0.
+    </para>
+    <para>
+    </para>
+  </refsection>
+  <refsection id="Defaultproperties_VirtualCLK0">
+    <title>Default properties</title>
+    <itemizedlist>
+      <listitem>
+        <para>
+          <emphasis role="bold">always active:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">direct-feedthrough:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">zero-crossing:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">mode:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">continuous-time state:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">discrete-time state:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">object discrete-time state:</emphasis> no
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <emphasis role="bold">name of computational function:</emphasis>
+          <emphasis role="italic">vrtclk0</emphasis>
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsection>
+  <refsection id="Interfacingfunction_VirtualCLK0">
+    <title>Interfacing function</title>
+    <itemizedlist>
+      <listitem>
+        <para>
+          <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Events/VirtualCLK0.sci">SCI/modules/scicos_blocks/macros/Events/VirtualCLK0.sci</link>
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/images/palettes/VirtualCLK0.png b/scilab/modules/xcos/images/palettes/VirtualCLK0.png
new file mode 100644 (file)
index 0000000..8c4350f
Binary files /dev/null and b/scilab/modules/xcos/images/palettes/VirtualCLK0.png differ