Help build: remove the householder image demo which open scinotes
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_data_structures / links / 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     <refsection id="link_scicos_link">
40         <title>link</title>
41         <para>
42             Size : 8.
43         </para>
44         <para>
45             Type : scilab list.
46         </para>
47         <para>
48             
49         </para>
50         <itemizedlist>
51             <listitem>
52                 <para>
53                     <emphasis role="bold">xx</emphasis>
54                 </para>
55                 <para> Vector of x coordinates of the link path.</para>
56                 <para> A link is defined as a polyline line.</para>
57                 <para> 
58                     Size : number of points of the link.
59                 </para>
60                 <para>
61                     Type : column vector of real numbers.
62                 </para>
63             </listitem>
64             <listitem>
65                 <para>
66                     <emphasis role="bold">yy</emphasis>
67                 </para>
68                 <para> Vector of y coordinates of the link path.</para>
69                 <para> A link is defined as a polyline line.</para>
70                 <para> 
71                     Size : number of points of the link.
72                 </para>
73                 <para>
74                     Type : column vector of real numbers.
75                 </para>
76             </listitem>
77             <listitem>
78                 <para>
79                     <emphasis role="bold">id</emphasis>
80                 </para>
81                 <para> Character string, the link identification.</para>
82                 <para> 
83                     Size : 1.
84                 </para>
85                 <para>
86                     Type : string.
87                 </para>
88             </listitem>
89             <listitem>
90                 <para>
91                     <emphasis role="bold">thick</emphasis>
92                 </para>
93                 <para> Vector of size two defining line thickness.</para>
94                 <para> 
95                     Size : 2.
96                 </para>
97                 <para>
98                     Type : row vector of integers.
99                 </para>
100             </listitem>
101             <listitem>
102                 <para>
103                     <emphasis role="bold">ct</emphasis>
104                 </para>
105                 <para> The first entry of this vector designates the color, and the second, the nature of the link. The second entry is 1 for a regular link, -1 for an activation link, and 2 for an implicit link.</para>
106                 <para> 
107                     Size : 2.
108                 </para>
109                 <para>
110                     Type : row vector of integers.
111                 </para>
112             </listitem>
113             <listitem>
114                 <para>
115                     <emphasis role="bold">from</emphasis>
116                 </para>
117                 <para> Vector of size three including the block number, port number, and port type (0 for output, 1 for input) at the origin of the link. Note that the third entry may be 1 if the link is implicit; otherwise it is zero.</para>
118                 <para> 
119                     Size : 3.
120                 </para>
121                 <para>
122                     Type : row vector of integers.
123                 </para>
124             </listitem>
125             <listitem>
126                 <para>
127                     <emphasis role="bold">to</emphasis>
128                 </para>
129                 <para> Vector of size three including the block number, port number, and port type (0 for output, 1 for input) at the destination of the link. Note that the third entry may be 1 if the link is implicit; otherwise it is zero.</para>
130                 <para> 
131                     Size : 3.
132                 </para>
133                 <para>
134                     Type : row vector of integers.
135                 </para>
136             </listitem>
137         </itemizedlist>
138     </refsection>
139     <refsection id="Filecontent_scicos_link">
140         <title>File content</title>
141         <itemizedlist>
142             <listitem>
143                 <para> SCI/modules/scicos/macros/scicos_scicos/scicos_link.sci</para>
144             </listitem>
145         </itemizedlist>
146     </refsection>
147 </refentry>