Xcos documentation: improve the rendering for data structures
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_data_structures / scicos_link.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_link">
25     <refnamediv>
26         <refname>scicos_link</refname>
27         <refpurpose>Define a link structure</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_link">
30         <title>Module</title>
31         <itemizedlist>
32             <listitem>
33                 <para>
34                     <link linkend="xcos">xcos</link>
35                 </para>
36             </listitem>
37         </itemizedlist>
38     </refsection>
39     <refsect1 id="link_scicos_link">
40         <title>link</title>
41         <para>Basic  structure that define a xcos link.</para>
42         <para>
43             Type : scilab tlist of type <code>"Link"</code> with fields :
44             <link linkend="scicos_link_xx">xx</link>, 
45             <link linkend="scicos_link_yy">yy</link>, 
46             <link linkend="scicos_link_id">id</link>, 
47             <link linkend="scicos_link_thick">thick</link>, 
48             <link linkend="scicos_link_ct">ct</link>, 
49             <link linkend="scicos_link_from">from</link> and
50             <link linkend="scicos_link_to">to</link>.
51         </para>
52         <refsect2 id="scicos_link_xx">
53             <title>xx</title>
54             <para> Vector of x coordinates of the link path. A link is defined as a polyline line.</para>
55             <para> 
56                 Size : number of points of the link.
57             </para>
58             <para>
59                 Type : column vector of real numbers.
60             </para>
61         </refsect2>
62         <refsect2 id="scicos_link_yy">
63             <title>yy</title>
64             <para> Vector of y coordinates of the link path. A link is defined as a polyline line.</para>
65             <para> 
66                 Size : number of points of the link.
67             </para>
68             <para>
69                 Type : column vector of real numbers.
70             </para>
71         </refsect2>
72         <refsect2 id="scicos_link_id">
73             <title>id</title>
74             <para> Character string, the link identification.</para>
75             <para> 
76                 Size : 1.
77             </para>
78             <para>
79                 Type : string.
80             </para>
81         </refsect2>
82         <refsect2 id="scicos_link_thick">
83             <title>thick</title>
84             <para> Vector of size two defining line thickness.</para>
85             <para> 
86                 Size : 2.
87             </para>
88             <para>
89                 Type : row vector of integers.
90             </para>
91         </refsect2>
92         <refsect2 id="scicos_link_ct">
93             <title>ct</title>
94             <para>
95                 The first entry of this vector designates the color, and the second, the nature of the link. The second entry is <code>1</code> for a regular link, <code>-1</code> for an activation link, and <code>2</code> for an implicit link.
96             </para>
97             <para> 
98                 Size : 2.
99             </para>
100             <para>
101                 Type : row vector of integers.
102             </para>
103         </refsect2>
104         <refsect2 id="scicos_link_from">
105             <title>from</title>
106             <para>
107                 Vector of size three including the block number, port number, and port type (<code>0</code> for output, <code>1</code> for input) at the origin of the link. Note that the third entry may be <code>1</code> if the link is implicit; otherwise it is zero.
108             </para>
109             <para> 
110                 Size : 3.
111             </para>
112             <para>
113                 Type : row vector of integers.
114             </para>
115         </refsect2>
116         <refsect2 id="scicos_link_to">
117             <title>to</title>
118             <para>
119                 Vector of size three including the block number, port number, and port type (<code>0</code> for output, <code>1</code> for input) at the destination of the link. Note that the third entry may be <code>0</code> if the link is implicit; otherwise it is one.
120             </para>
121             <para> 
122                 Size : 3.
123             </para>
124             <para>
125                 Type : row vector of integers.
126             </para>
127         </refsect2>
128     </refsect1>
129     <refsection>
130         <title>Examples</title>
131         <programlisting role="example"><![CDATA[ 
132 loadXcosLibs();              // load standard library
133
134 lnk = scicos_link();    // new specific block
135 tree_show(lnk);              // display it
136  ]]></programlisting>
137         <programlisting role="example"><![CDATA[ 
138 lnk = scicos_link(),
139 lnk.id = "My_label"
140  ]]></programlisting>
141     </refsection>
142 </refentry>