← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/scilab_utilities_functions/standard_outputs.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xcos/help/en_US/scilab_utilities_functions/standard_outputs.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
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" version="5.0-subset Scilab" xml:id="standard_outputs">
3
 
  <refnamediv>
4
 
    <refname>standard_outputs</refname>
5
 
    <refpurpose>Get the position of the output ports of a block in Xcos editor.</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>[x,y,typ] = standard_outputs(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 is used to get the position (<varname>x</varname>,<varname>y</varname>) of each output port of an Xcos block.
51
 
    </para>
52
 
  </refsection>
53
 
  <refsection>
54
 
    <title>Example</title>
55
 
    <programlisting role="example"><![CDATA[
 
3
    <refnamediv>
 
4
        <refname>standard_outputs</refname>
 
5
        <refpurpose>Get the position of the output ports of a block in Xcos editor.</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>[x,y,typ] = standard_outputs(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 is used to get the position (<varname>x</varname>,<varname>y</varname>) of each output port of an Xcos block.
 
51
        </para>
 
52
    </refsection>
 
53
    <refsection>
 
54
        <title>Example</title>
 
55
        <programlisting role="example"><![CDATA[
56
56
loadXcosLibs();
57
57
o1 = DELAYV_f("define");
58
58
[x1,y1,typ1] = standard_outputs(o1)
59
59
o2 = Capacitor("define");
60
60
[x2,y2,typ2] = standard_inputs(o2)
61
61
    ]]></programlisting>
62
 
  </refsection>
63
 
  <refsection role="see also">
64
 
    <title>See Also</title>
65
 
    <simplelist type="inline">
66
 
      <member>
67
 
        <link linkend="standard_inputs">standard_inputs</link>
68
 
      </member>
69
 
      <member>
70
 
        <link linkend="standard_origin">standard_origin</link>
71
 
      </member>
72
 
    </simplelist>
73
 
  </refsection>
 
62
    </refsection>
 
63
    <refsection role="see also">
 
64
        <title>See Also</title>
 
65
        <simplelist type="inline">
 
66
            <member>
 
67
                <link linkend="standard_inputs">standard_inputs</link>
 
68
            </member>
 
69
            <member>
 
70
                <link linkend="standard_origin">standard_origin</link>
 
71
            </member>
 
72
        </simplelist>
 
73
    </refsection>
74
74
</refentry>