Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 7474

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
  <compounddef id="classfusb__ephandle__generic" kind="class" prot="public">
    <compoundname>fusb_ephandle_generic</compoundname>
    <basecompoundref refid="classfusb__ephandle" prot="public" virt="non-virtual">fusb_ephandle</basecompoundref>
    <includes refid="fusb__generic_8h" local="no">fusb_generic.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classfusb__ephandle__generic_1ad40d183429d2c7c77f265828d6f6a2db" prot="private" static="no" mutable="no">
        <type><ref refid="classfusb__devhandle__generic" kindref="compound">fusb_devhandle_generic</ref> *</type>
        <definition>fusb_devhandle_generic* fusb_ephandle_generic::d_devhandle</definition>
        <argsstring></argsstring>
        <name>d_devhandle</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" bodystart="50" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classfusb__ephandle__generic_1a830f0afd5a768fef69afaf68c26791f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>fusb_ephandle_generic::fusb_ephandle_generic</definition>
        <argsstring>(fusb_devhandle_generic *dh, int endpoint, bool input_p, int block_size=0, int nblocks=0)</argsstring>
        <name>fusb_ephandle_generic</name>
        <param>
          <type><ref refid="classfusb__devhandle__generic" kindref="compound">fusb_devhandle_generic</ref> *</type>
          <declname>dh</declname>
        </param>
        <param>
          <type>int</type>
          <declname>endpoint</declname>
        </param>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>input_p</declname>
        </param>
        <param>
          <type>int</type>
          <declname>block_size</declname>
          <defval>0</defval>
        </param>
        <param>
          <type>int</type>
          <declname>nblocks</declname>
          <defval>0</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="55"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__generic_1a46e53a8ce5446542ec27ecf8b8009e3c" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual fusb_ephandle_generic::~fusb_ephandle_generic</definition>
        <argsstring>()</argsstring>
        <name>~fusb_ephandle_generic</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="56"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__generic_1a9fc2262b4072a85a835942723b8f39c6" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>virtual bool fusb_ephandle_generic::start</definition>
        <argsstring>()</argsstring>
        <name>start</name>
        <reimplements refid="classfusb__ephandle_1aac0498804e009ab78c47f2265f34a054">start</reimplements>
        <briefdescription>
<para>begin streaming i/o </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="60"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__generic_1aa563a49a03165b2b23a1b9f8529db942" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>virtual bool fusb_ephandle_generic::stop</definition>
        <argsstring>()</argsstring>
        <name>stop</name>
        <reimplements refid="classfusb__ephandle_1a3cfe2cbb78870a6ce0ec8f696ebe45ab">stop</reimplements>
        <briefdescription>
<para>stop streaming i/o </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="61"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__generic_1a2af659b1b0c8a74a59e9059878a1e496" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int fusb_ephandle_generic::write</definition>
        <argsstring>(const void *buffer, int nbytes)</argsstring>
        <name>write</name>
        <reimplements refid="classfusb__ephandle_1ab2a965c0f5fea6632bc08ea59c8c8fe1">write</reimplements>
        <param>
          <type>const void *</type>
          <declname>buffer</declname>
        </param>
        <param>
          <type>int</type>
          <declname>nbytes</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para><computeroutput>nbytes</computeroutput> if write was successfully enqueued, else -1. Will block if no free buffers available. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="67"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__generic_1a893ea1a1d60ba9f0a41b6a1bba31edaf" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int fusb_ephandle_generic::read</definition>
        <argsstring>(void *buffer, int nbytes)</argsstring>
        <name>read</name>
        <reimplements refid="classfusb__ephandle_1a835533e974fb159174c44f2ec0d5668d">read</reimplements>
        <param>
          <type>void *</type>
          <declname>buffer</declname>
        </param>
        <param>
          <type>int</type>
          <declname>nbytes</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>number of bytes read or -1 if error. number of bytes read will be &lt;= nbytes. Will block if no input available. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="74"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__generic_1a7a7ef010b4fb8307ba4c6c29c88a020a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>void</type>
        <definition>virtual void fusb_ephandle_generic::wait_for_completion</definition>
        <argsstring>()</argsstring>
        <name>wait_for_completion</name>
        <reimplements refid="classfusb__ephandle_1a1e1a2c7173a14aea99686fad7c0e061c">wait_for_completion</reimplements>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="79" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" bodystart="79" bodyend="79"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>generic implementation of <ref refid="classfusb__ephandle" kindref="compound">fusb_ephandle</ref> using only libusb </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="5040">
        <label>fusb_ephandle_generic</label>
        <link refid="classfusb__ephandle__generic"/>
        <childnode refid="5041" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5041">
        <label>fusb_ephandle</label>
        <link refid="classfusb__ephandle"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="5044">
        <label>fusb_devhandle_generic</label>
        <link refid="classfusb__devhandle__generic"/>
        <childnode refid="5045" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5042">
        <label>fusb_ephandle_generic</label>
        <link refid="classfusb__ephandle__generic"/>
        <childnode refid="5043" relation="public-inheritance">
        </childnode>
        <childnode refid="5044" relation="usage">
          <edgelabel>d_devhandle</edgelabel>
        </childnode>
      </node>
      <node id="5046">
        <label>usb_dev_handle</label>
        <link refid="structusb__dev__handle"/>
      </node>
      <node id="5045">
        <label>fusb_devhandle</label>
        <link refid="classfusb__devhandle"/>
        <childnode refid="5046" relation="usage">
          <edgelabel>d_udh</edgelabel>
        </childnode>
      </node>
      <node id="5043">
        <label>fusb_ephandle</label>
        <link refid="classfusb__ephandle"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_generic.h" bodystart="47" bodyend="80"/>
    <listofallmembers>
      <member refid="classfusb__ephandle_1a969c00b4d8ef3c8ad6444eb92da7a61c" prot="public" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>block_size</name></member>
      <member refid="classfusb__ephandle_1aa8b4afe1f6aaa45491d9ae0dfdad3c0b" prot="protected" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>d_block_size</name></member>
      <member refid="classfusb__ephandle__generic_1ad40d183429d2c7c77f265828d6f6a2db" prot="private" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>d_devhandle</name></member>
      <member refid="classfusb__ephandle_1a136e1ab7ba9e180a78ea5085739dd018" prot="protected" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>d_endpoint</name></member>
      <member refid="classfusb__ephandle_1a123fcada49a57077500fab084e537643" prot="protected" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>d_input_p</name></member>
      <member refid="classfusb__ephandle_1a3d38bb3ad76925c044fe8e14ecb408e7" prot="protected" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>d_nblocks</name></member>
      <member refid="classfusb__ephandle_1ad6506c0efdf8eea1dcd8df8d65ecc609" prot="protected" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>d_started</name></member>
      <member refid="classfusb__ephandle_1a5ad892734f7649f8444ce6c5fe33382e" prot="public" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>fusb_ephandle</name></member>
      <member refid="classfusb__ephandle__generic_1a830f0afd5a768fef69afaf68c26791f3" prot="public" virt="non-virtual"><scope>fusb_ephandle_generic</scope><name>fusb_ephandle_generic</name></member>
      <member refid="classfusb__ephandle__generic_1a893ea1a1d60ba9f0a41b6a1bba31edaf" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>read</name></member>
      <member refid="classfusb__ephandle__generic_1a9fc2262b4072a85a835942723b8f39c6" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>start</name></member>
      <member refid="classfusb__ephandle__generic_1aa563a49a03165b2b23a1b9f8529db942" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>stop</name></member>
      <member refid="classfusb__ephandle__generic_1a7a7ef010b4fb8307ba4c6c29c88a020a" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>wait_for_completion</name></member>
      <member refid="classfusb__ephandle__generic_1a2af659b1b0c8a74a59e9059878a1e496" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>write</name></member>
      <member refid="classfusb__ephandle_1abda7e264c5e0bef062d3d356fb91e371" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>~fusb_ephandle</name></member>
      <member refid="classfusb__ephandle__generic_1a46e53a8ce5446542ec27ecf8b8009e3c" prot="public" virt="virtual"><scope>fusb_ephandle_generic</scope><name>~fusb_ephandle_generic</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>