scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_block.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scicos
   4  *
   5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
   6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  *
  22  * See the file ./license.txt
  23  -->
  24 <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:id="scicos_block">
  25     <refnamediv>
  26         <refname>scicos_block</refname>
  27         <refpurpose>Define a block structure</refpurpose>
  28     </refnamediv>
  29     <refsection id="block_scicos_block">
  30         <title>block</title>
  31         <para>
  32             Basic structure that define a xcos block.
  33         </para>
  34         <para>
  35             Type : scilab tlist of type <code>"Block"</code> with fields :
  36             <link linkend="scicos_block_graphics">graphics</link>,
  37             <link linkend="scicos_block_model">model</link>,
  38             <link linkend="scicos_block_gui">gui</link> and
  39             <link linkend="scicos_block_doc">doc</link>.
  40         </para>
  41         <refsect2 id="scicos_block_graphics">
  42             <title>graphics</title>
  43             <para> Scilab object including graphical information concerning the features of the block.</para>
  44             <para>
  45                 Type : <link linkend="scicos_graphics">graphics</link>.
  46             </para>
  47         </refsect2>
  48         <refsect2 id="scicos_block_model">
  49             <title>model</title>
  50             <para> Scilab list that contains the features of the block used for the compilation.</para>
  51             <para>
  52                 Type : <link linkend="scicos_model">model</link>.
  53             </para>
  54         </refsect2>
  55         <refsect2 id="scicos_block_gui">
  56             <title>gui</title>
  57             <para> The name of the Scilab GUI function associated with the block.</para>
  58             <para>
  59                 Size : 1.
  60             </para>
  61             <para>
  62                 Type : string.
  63             </para>
  64         </refsect2>
  65         <refsect2 id="scicos_block_doc">
  66             <title>doc</title>
  67             <para> Field used for documentation of the block
  68                 Size : 1.
  69             </para>
  70             <para>
  71                 Type : list or string.
  72             </para>
  73         </refsect2>
  74     </refsection>
  75     <refsection>
  76         <title>Examples</title>
  77         <programlisting role="example"><![CDATA[
  78 loadXcosLibs();              // load standard library
  79
  80 blk = BIGSOM_f("define");    // new specific block
  81 tree_show(blk);              // display it
  82  ]]></programlisting>
  83         <programlisting role="example"><![CDATA[
  84 blk = scicos_block(),
  85 blk.model.rpar = 1
  86  ]]></programlisting>
  87     </refsection>
  88 </refentry>
  89