Sophie

Sophie

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

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__ra__wb" kind="class" prot="public">
    <compoundname>fusb_ephandle_ra_wb</compoundname>
    <basecompoundref refid="classfusb__ephandle" prot="public" virt="non-virtual">fusb_ephandle</basecompoundref>
    <includes refid="fusb__ra__wb_8h" local="no">fusb_ra_wb.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classfusb__ephandle__ra__wb_1a4fdda618fc2f0b0b9902cc09cdd6bd93" prot="private" static="no" mutable="no">
        <type><ref refid="classfusb__devhandle__ra__wb" kindref="compound">fusb_devhandle_ra_wb</ref> *</type>
        <definition>fusb_devhandle_ra_wb* fusb_ephandle_ra_wb::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_ra_wb.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_ra_wb.h" bodystart="50" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classfusb__ephandle__ra__wb_1a36122057665cbf8e342de61391e09aeb" prot="private" static="no" mutable="no">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool fusb_ephandle_ra_wb::d_ra_wb_on</definition>
        <argsstring></argsstring>
        <name>d_ra_wb_on</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_ra_wb.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_ra_wb.h" bodystart="51" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1a45fe615379716a663eb9c08f2f0430df" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>fusb_ephandle_ra_wb::fusb_ephandle_ra_wb</definition>
        <argsstring>(fusb_devhandle_ra_wb *dh, int endpoint, bool input_p, int block_size=0, int nblocks=0)</argsstring>
        <name>fusb_ephandle_ra_wb</name>
        <param>
          <type><ref refid="classfusb__devhandle__ra__wb" kindref="compound">fusb_devhandle_ra_wb</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_ra_wb.h" line="56"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1ad281abc3da0454750af573ba456c02a1" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual fusb_ephandle_ra_wb::~fusb_ephandle_ra_wb</definition>
        <argsstring>()</argsstring>
        <name>~fusb_ephandle_ra_wb</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_ra_wb.h" line="57"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1af2ec65d180691b02fa516e8c5e7000ef" 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_ra_wb::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_ra_wb.h" line="61"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1af3db5ab8da0dd49e1d92d64e208ebd1a" 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_ra_wb::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_ra_wb.h" line="62"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1aae056e1b0bc907b2591b6c9876ed9cc3" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int fusb_ephandle_ra_wb::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_ra_wb.h" line="68"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1a11d626f39f48c4ae3308c90d8f65f469" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int fusb_ephandle_ra_wb::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_ra_wb.h" line="75"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle__ra__wb_1a63eec088aca166d257b187cbe13b5b5b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>virtual void fusb_ephandle_ra_wb::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_ra_wb.h" line="80"/>
      </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="5055">
        <label>fusb_ephandle_ra_wb</label>
        <link refid="classfusb__ephandle__ra__wb"/>
        <childnode refid="5056" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5056">
        <label>fusb_ephandle</label>
        <link refid="classfusb__ephandle"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="5057">
        <label>fusb_ephandle_ra_wb</label>
        <link refid="classfusb__ephandle__ra__wb"/>
        <childnode refid="5058" relation="public-inheritance">
        </childnode>
        <childnode refid="5059" relation="usage">
          <edgelabel>d_devhandle</edgelabel>
        </childnode>
      </node>
      <node id="5061">
        <label>usb_dev_handle</label>
        <link refid="structusb__dev__handle"/>
      </node>
      <node id="5060">
        <label>fusb_devhandle</label>
        <link refid="classfusb__devhandle"/>
        <childnode refid="5061" relation="usage">
          <edgelabel>d_udh</edgelabel>
        </childnode>
      </node>
      <node id="5058">
        <label>fusb_ephandle</label>
        <link refid="classfusb__ephandle"/>
      </node>
      <node id="5059">
        <label>fusb_devhandle_ra_wb</label>
        <link refid="classfusb__devhandle__ra__wb"/>
        <childnode refid="5060" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_ra_wb.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb_ra_wb.h" bodystart="47" bodyend="81"/>
    <listofallmembers>
      <member refid="classfusb__ephandle_1a969c00b4d8ef3c8ad6444eb92da7a61c" prot="public" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>block_size</name></member>
      <member refid="classfusb__ephandle_1aa8b4afe1f6aaa45491d9ae0dfdad3c0b" prot="protected" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_block_size</name></member>
      <member refid="classfusb__ephandle__ra__wb_1a4fdda618fc2f0b0b9902cc09cdd6bd93" prot="private" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_devhandle</name></member>
      <member refid="classfusb__ephandle_1a136e1ab7ba9e180a78ea5085739dd018" prot="protected" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_endpoint</name></member>
      <member refid="classfusb__ephandle_1a123fcada49a57077500fab084e537643" prot="protected" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_input_p</name></member>
      <member refid="classfusb__ephandle_1a3d38bb3ad76925c044fe8e14ecb408e7" prot="protected" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_nblocks</name></member>
      <member refid="classfusb__ephandle__ra__wb_1a36122057665cbf8e342de61391e09aeb" prot="private" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_ra_wb_on</name></member>
      <member refid="classfusb__ephandle_1ad6506c0efdf8eea1dcd8df8d65ecc609" prot="protected" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>d_started</name></member>
      <member refid="classfusb__ephandle_1a5ad892734f7649f8444ce6c5fe33382e" prot="public" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>fusb_ephandle</name></member>
      <member refid="classfusb__ephandle__ra__wb_1a45fe615379716a663eb9c08f2f0430df" prot="public" virt="non-virtual"><scope>fusb_ephandle_ra_wb</scope><name>fusb_ephandle_ra_wb</name></member>
      <member refid="classfusb__ephandle__ra__wb_1a11d626f39f48c4ae3308c90d8f65f469" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>read</name></member>
      <member refid="classfusb__ephandle__ra__wb_1af2ec65d180691b02fa516e8c5e7000ef" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>start</name></member>
      <member refid="classfusb__ephandle__ra__wb_1af3db5ab8da0dd49e1d92d64e208ebd1a" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>stop</name></member>
      <member refid="classfusb__ephandle__ra__wb_1a63eec088aca166d257b187cbe13b5b5b" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>wait_for_completion</name></member>
      <member refid="classfusb__ephandle__ra__wb_1aae056e1b0bc907b2591b6c9876ed9cc3" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>write</name></member>
      <member refid="classfusb__ephandle_1abda7e264c5e0bef062d3d356fb91e371" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>~fusb_ephandle</name></member>
      <member refid="classfusb__ephandle__ra__wb_1ad281abc3da0454750af573ba456c02a1" prot="public" virt="virtual"><scope>fusb_ephandle_ra_wb</scope><name>~fusb_ephandle_ra_wb</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>