* Bug #13071 fixed - Xcos help: "obsolete" functions
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / standard_inputs.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="standard_inputs">
3     <refnamediv>
4         <refname>standard_inputs</refname>
5         <refpurpose>Get the position of the input ports of a block in Xcos editor.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[x,y,typ] = standard_inputs(block)
10         </synopsis>
11     </refsynopsisdiv>
12     <refsection>
13         <title>Arguments</title>
14         <variablelist>
15             <varlistentry>
16                 <term>block</term>
17                 <listitem>
18                     <para>xcos block.</para>
19                 </listitem>
20             </varlistentry>
21             <varlistentry>
22                 <term>x</term>
23                 <listitem>
24                     <para>
25                         x position of the port. When multiple ports are described, <varname>x</varname> is a float vector of x positions.
26                     </para>
27                 </listitem>
28             </varlistentry>
29             <varlistentry>
30                 <term>y</term>
31                 <listitem>
32                     <para>
33                         y position of the port. When multiple ports are described, <varname>y</varname> is a float vector of y positions.
34                     </para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>typ</term>
39                 <listitem>
40                     <para>
41                         determine the type of ports. It can take the following values: <literal>-1</literal> if this is a clock port; <literal>1</literal> if this is an explicit port; <literal>2</literal> if this is an implicit port. When multiple ports are described, <varname>typ</varname> is a vector.
42                     </para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46     </refsection>
47     <refsection>
48         <title>Description</title>
49         <para>
50             This Scilab function was used by the Scicos blocks interfacing functions
51             to get the position (<varname>x</varname>, <varname>y</varname>) of each input port.
52         </para>
53         <para>
54             <warning>
55                 This function is not useful for Xcos block interfacing functions anymore.
56                 The Xcos interfacing functions are not called with <literal>job="getorigin"</literal> anymore.
57             </warning>
58         </para>
59     </refsection>
60     <refsection>
61         <title>Example</title>
62         <programlisting role="example"><![CDATA[
63 loadXcosLibs();
64 o1 = CSCOPE("define");
65 [x1,y1,typ1] = standard_inputs(o1)
66 o2 = Capacitor("define");
67 [x2,y2,typ2] = standard_inputs(o2)
68     ]]></programlisting>
69     </refsection>
70     <refsection role="see also">
71         <title>See Also</title>
72         <simplelist type="inline">
73             <member>
74                 <link linkend="standard_outputs">standard_outputs</link>
75             </member>
76             <member>
77                 <link linkend="standard_origin">standard_origin</link>
78             </member>
79         </simplelist>
80     </refsection>
81 </refentry>