opcodes/invalue.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

<refentry id="invalue">
<indexterm id="IndexInvalue"><primary>invalue</primary></indexterm>
  <refentryinfo><title>Signal I/O:Signal Input</title></refentryinfo>
  <refmeta>
    <refentrytitle>invalue</refentrytitle>
  </refmeta>


  <refnamediv>
    <refname>invalue</refname>
    <refpurpose>
      Reads a k-rate signal from a user-defined channel.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Reads a k-rate signal or string from a user-defined channel.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>kvalue <command>invalue</command> &quot;channel name&quot;</synopsis>
    <synopsis>Sname <command>invalue</command> &quot;channel name&quot;</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kvalue</emphasis> -- The k-rate value that is read from the channel.
    </para>

    <para>
      <emphasis> Sname </emphasis> -- The string variable that is read from the channel.
    </para>

    <para>
      <emphasis>&quot;channel name&quot;</emphasis> -- An integer, string (in double-quotes), or string variable identifying the channel.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="outvalue"><citetitle>outvalue</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Matt Ingalls</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>