Sophie

Sophie

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

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" kind="class" prot="public">
    <compoundname>fusb_ephandle</compoundname>
    <derivedcompoundref refid="classfusb__ephandle__darwin" prot="public" virt="non-virtual">fusb_ephandle_darwin</derivedcompoundref>
    <derivedcompoundref refid="classfusb__ephandle__generic" prot="public" virt="non-virtual">fusb_ephandle_generic</derivedcompoundref>
    <derivedcompoundref refid="classfusb__ephandle__linux" prot="public" virt="non-virtual">fusb_ephandle_linux</derivedcompoundref>
    <derivedcompoundref refid="classfusb__ephandle__ra__wb" prot="public" virt="non-virtual">fusb_ephandle_ra_wb</derivedcompoundref>
    <derivedcompoundref refid="classfusb__ephandle__win32" prot="public" virt="non-virtual">fusb_ephandle_win32</derivedcompoundref>
    <includes refid="fusb_8h" local="no">fusb.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classfusb__ephandle_1a136e1ab7ba9e180a78ea5085739dd018" prot="protected" static="no" mutable="no">
        <type>int</type>
        <definition>int fusb_ephandle::d_endpoint</definition>
        <argsstring></argsstring>
        <name>d_endpoint</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="72" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="72" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classfusb__ephandle_1a123fcada49a57077500fab084e537643" prot="protected" static="no" mutable="no">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool fusb_ephandle::d_input_p</definition>
        <argsstring></argsstring>
        <name>d_input_p</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="73" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="73" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classfusb__ephandle_1aa8b4afe1f6aaa45491d9ae0dfdad3c0b" prot="protected" static="no" mutable="no">
        <type>int</type>
        <definition>int fusb_ephandle::d_block_size</definition>
        <argsstring></argsstring>
        <name>d_block_size</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="74" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="74" bodyend="-1"/>
        <referencedby refid="classfusb__ephandle_1a969c00b4d8ef3c8ad6444eb92da7a61c" compoundref="fusb_8h" startline="107" endline="107">block_size</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classfusb__ephandle_1a3d38bb3ad76925c044fe8e14ecb408e7" prot="protected" static="no" mutable="no">
        <type>int</type>
        <definition>int fusb_ephandle::d_nblocks</definition>
        <argsstring></argsstring>
        <name>d_nblocks</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="75" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="75" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classfusb__ephandle_1ad6506c0efdf8eea1dcd8df8d65ecc609" prot="protected" static="no" mutable="no">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool fusb_ephandle::d_started</definition>
        <argsstring></argsstring>
        <name>d_started</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="76" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="76" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classfusb__ephandle_1a5897e0a4e8e291230191462b511ec277" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>fusb_ephandle::fusb_ephandle</definition>
        <argsstring>(const fusb_ephandle &amp;rhs)</argsstring>
        <name>fusb_ephandle</name>
        <param>
          <type>const <ref refid="classfusb__ephandle" kindref="compound">fusb_ephandle</ref> &amp;</type>
          <declname>rhs</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="68"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1a6c580ad2655ee741bd453b7bd0139ef0" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classfusb__ephandle" kindref="compound">fusb_ephandle</ref> &amp;</type>
        <definition>fusb_ephandle&amp; fusb_ephandle::operator=</definition>
        <argsstring>(const fusb_ephandle &amp;rhs)</argsstring>
        <name>operator=</name>
        <param>
          <type>const <ref refid="classfusb__ephandle" kindref="compound">fusb_ephandle</ref> &amp;</type>
          <declname>rhs</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="69"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classfusb__ephandle_1a5ad892734f7649f8444ce6c5fe33382e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>fusb_ephandle::fusb_ephandle</definition>
        <argsstring>(int endpoint, bool input_p, int block_size=0, int nblocks=0)</argsstring>
        <name>fusb_ephandle</name>
        <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.h" line="80"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1abda7e264c5e0bef062d3d356fb91e371" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual fusb_ephandle::~fusb_ephandle</definition>
        <argsstring>()</argsstring>
        <name>~fusb_ephandle</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="81"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1aac0498804e009ab78c47f2265f34a054" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>virtual bool fusb_ephandle::start</definition>
        <argsstring>()=0</argsstring>
        <name>start</name>
        <reimplementedby refid="classfusb__ephandle__win32_1a6528a238f3f19d84d4dd2e7d0a9a8de3">start</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__ra__wb_1af2ec65d180691b02fa516e8c5e7000ef">start</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__linux_1ad3b4fd0fe703bfc41b9450109270c3a8">start</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__generic_1a9fc2262b4072a85a835942723b8f39c6">start</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__darwin_1a40eaefdc5e87eb13a41397c59c0e9739">start</reimplementedby>
        <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.h" line="83"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1a3cfe2cbb78870a6ce0ec8f696ebe45ab" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>virtual bool fusb_ephandle::stop</definition>
        <argsstring>()=0</argsstring>
        <name>stop</name>
        <reimplementedby refid="classfusb__ephandle__win32_1a1a26fbc871834e3730789b8575d3714b">stop</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__ra__wb_1af3db5ab8da0dd49e1d92d64e208ebd1a">stop</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__linux_1affb663e8d315ac1cec6ed3a2b899117d">stop</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__generic_1aa563a49a03165b2b23a1b9f8529db942">stop</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__darwin_1a432201be192a5f5569137ed03a17e417">stop</reimplementedby>
        <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.h" line="84"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1ab2a965c0f5fea6632bc08ea59c8c8fe1" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>int</type>
        <definition>virtual int fusb_ephandle::write</definition>
        <argsstring>(const void *buffer, int nbytes)=0</argsstring>
        <name>write</name>
        <reimplementedby refid="classfusb__ephandle__win32_1a2b4d0892ae085ae52a005ccec3efaab6">write</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__ra__wb_1aae056e1b0bc907b2591b6c9876ed9cc3">write</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__linux_1ab4965dbc78419694a0e944b2c13025a9">write</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__generic_1a2af659b1b0c8a74a59e9059878a1e496">write</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__darwin_1aa5309b810e28ef13367f18ce75621ff4">write</reimplementedby>
        <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.h" line="90"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1a835533e974fb159174c44f2ec0d5668d" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>int</type>
        <definition>virtual int fusb_ephandle::read</definition>
        <argsstring>(void *buffer, int nbytes)=0</argsstring>
        <name>read</name>
        <reimplementedby refid="classfusb__ephandle__win32_1a2189b5c79aab4f36c779242f22589368">read</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__ra__wb_1a11d626f39f48c4ae3308c90d8f65f469">read</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__linux_1af6f9efb9b0e5a84d90127752c5ffbdf4">read</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__generic_1a893ea1a1d60ba9f0a41b6a1bba31edaf">read</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__darwin_1a3084456988799e1875c26f47f453e99a">read</reimplementedby>
        <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.h" line="97"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1a1e1a2c7173a14aea99686fad7c0e061c" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void fusb_ephandle::wait_for_completion</definition>
        <argsstring>()=0</argsstring>
        <name>wait_for_completion</name>
        <reimplementedby refid="classfusb__ephandle__win32_1a385c96d5f778ac688af634ca999b1fa3">wait_for_completion</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__ra__wb_1a63eec088aca166d257b187cbe13b5b5b">wait_for_completion</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__linux_1afb983ac99b988c8da1fb1beffcafe2f4">wait_for_completion</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__generic_1a7a7ef010b4fb8307ba4c6c29c88a020a">wait_for_completion</reimplementedby>
        <reimplementedby refid="classfusb__ephandle__darwin_1a57b384a96ddc156c69b69eaef0a52b95">wait_for_completion</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="102"/>
      </memberdef>
      <memberdef kind="function" id="classfusb__ephandle_1a969c00b4d8ef3c8ad6444eb92da7a61c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int fusb_ephandle::block_size</definition>
        <argsstring>()</argsstring>
        <name>block_size</name>
        <briefdescription>
<para>returns current block size. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="107" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="107" bodyend="107"/>
        <references refid="classfusb__ephandle_1aa8b4afe1f6aaa45491d9ae0dfdad3c0b" compoundref="fusb_8h" startline="74">d_block_size</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>abstract usb end point handle </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="5023">
        <label>fusb_ephandle_ra_wb</label>
        <link refid="classfusb__ephandle__ra__wb"/>
        <childnode refid="5019" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5021">
        <label>fusb_ephandle_generic</label>
        <link refid="classfusb__ephandle__generic"/>
        <childnode refid="5019" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5024">
        <label>fusb_ephandle_win32</label>
        <link refid="classfusb__ephandle__win32"/>
        <childnode refid="5019" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5022">
        <label>fusb_ephandle_linux</label>
        <link refid="classfusb__ephandle__linux"/>
        <childnode refid="5019" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5019">
        <label>fusb_ephandle</label>
        <link refid="classfusb__ephandle"/>
      </node>
      <node id="5020">
        <label>fusb_ephandle_darwin</label>
        <link refid="classfusb__ephandle__darwin"/>
        <childnode refid="5019" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" line="65" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp/host/lib/legacy/fusb.h" bodystart="65" bodyend="108"/>
    <listofallmembers>
      <member refid="classfusb__ephandle_1a969c00b4d8ef3c8ad6444eb92da7a61c" prot="public" virt="non-virtual"><scope>fusb_ephandle</scope><name>block_size</name></member>
      <member refid="classfusb__ephandle_1aa8b4afe1f6aaa45491d9ae0dfdad3c0b" prot="protected" virt="non-virtual"><scope>fusb_ephandle</scope><name>d_block_size</name></member>
      <member refid="classfusb__ephandle_1a136e1ab7ba9e180a78ea5085739dd018" prot="protected" virt="non-virtual"><scope>fusb_ephandle</scope><name>d_endpoint</name></member>
      <member refid="classfusb__ephandle_1a123fcada49a57077500fab084e537643" prot="protected" virt="non-virtual"><scope>fusb_ephandle</scope><name>d_input_p</name></member>
      <member refid="classfusb__ephandle_1a3d38bb3ad76925c044fe8e14ecb408e7" prot="protected" virt="non-virtual"><scope>fusb_ephandle</scope><name>d_nblocks</name></member>
      <member refid="classfusb__ephandle_1ad6506c0efdf8eea1dcd8df8d65ecc609" prot="protected" virt="non-virtual"><scope>fusb_ephandle</scope><name>d_started</name></member>
      <member refid="classfusb__ephandle_1a5897e0a4e8e291230191462b511ec277" prot="private" virt="non-virtual"><scope>fusb_ephandle</scope><name>fusb_ephandle</name></member>
      <member refid="classfusb__ephandle_1a5ad892734f7649f8444ce6c5fe33382e" prot="public" virt="non-virtual"><scope>fusb_ephandle</scope><name>fusb_ephandle</name></member>
      <member refid="classfusb__ephandle_1a6c580ad2655ee741bd453b7bd0139ef0" prot="private" virt="non-virtual"><scope>fusb_ephandle</scope><name>operator=</name></member>
      <member refid="classfusb__ephandle_1a835533e974fb159174c44f2ec0d5668d" prot="public" virt="pure-virtual"><scope>fusb_ephandle</scope><name>read</name></member>
      <member refid="classfusb__ephandle_1aac0498804e009ab78c47f2265f34a054" prot="public" virt="pure-virtual"><scope>fusb_ephandle</scope><name>start</name></member>
      <member refid="classfusb__ephandle_1a3cfe2cbb78870a6ce0ec8f696ebe45ab" prot="public" virt="pure-virtual"><scope>fusb_ephandle</scope><name>stop</name></member>
      <member refid="classfusb__ephandle_1a1e1a2c7173a14aea99686fad7c0e061c" prot="public" virt="pure-virtual"><scope>fusb_ephandle</scope><name>wait_for_completion</name></member>
      <member refid="classfusb__ephandle_1ab2a965c0f5fea6632bc08ea59c8c8fe1" prot="public" virt="pure-virtual"><scope>fusb_ephandle</scope><name>write</name></member>
      <member refid="classfusb__ephandle_1abda7e264c5e0bef062d3d356fb91e371" prot="public" virt="virtual"><scope>fusb_ephandle</scope><name>~fusb_ephandle</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>