Sophie

Sophie

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

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="classusrp2_1_1rx__sample__handler" kind="class" prot="public">
    <compoundname>usrp2::rx_sample_handler</compoundname>
    <derivedcompoundref refid="classusrp2_1_1rx__nop__handler" prot="public" virt="non-virtual">usrp2::rx_nop_handler</derivedcompoundref>
    <includes refid="rx__sample__handler_8h" local="no">rx_sample_handler.h</includes>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classusrp2_1_1rx__sample__handler_1a014d9cd0873e8da27a952ffa756a96b9" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual usrp2::rx_sample_handler::~rx_sample_handler</definition>
        <argsstring>()</argsstring>
        <name>~rx_sample_handler</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_sample_handler.h" line="36"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__sample__handler_1a6f603e963d9bc69ee5c8bb9ae79d9192" 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 usrp2::rx_sample_handler::operator()</definition>
        <argsstring>(const uint32_t *items, size_t nitems, const rx_metadata *metadata)=0</argsstring>
        <name>operator()</name>
        <reimplementedby refid="classusrp2_1_1rx__nop__handler_1aa274f87d6c1d8de9dc412e9c00b4d955">operator()</reimplementedby>
        <reimplementedby refid="classrx__32fc__handler_1a47e45988d2ca67fefcf9cb0aaffab2f7">operator()</reimplementedby>
        <reimplementedby refid="classrx__16sc__handler_1aa64777749da89a212b1e07d96c5e44fb">operator()</reimplementedby>
        <param>
          <type>const uint32_t *</type>
          <declname>items</declname>
        </param>
        <param>
          <type>size_t</type>
          <declname>nitems</declname>
        </param>
        <param>
          <type>const <ref refid="structusrp2_1_1rx__metadata" kindref="compound">rx_metadata</ref> *</type>
          <declname>metadata</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>items</parametername>
</parameternamelist>
<parameterdescription>
<para>points to the first 32-bit word of uninterpreted sample data in the frame. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>nitems</parametername>
</parameternamelist>
<parameterdescription>
<para>is the number of entries in the frame in units of uint32_t&apos;s. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>metadata</parametername>
</parameternamelist>
<parameterdescription>
<para>is the additional per frame data provided by the USRP2 FPGA.</para></parameterdescription>
</parameteritem>
</parameterlist>
<computeroutput>items</computeroutput> points to the raw sample data received off of the ethernet. The data is packed into big-endian 32-bit unsigned ints for transport, but the actual format of the data is dependent on the current configuration of the USRP2. The most common format is 16-bit I &amp; Q, with I in the top of the 32-bit word.</para><para>This is the general purpose, low level interface and relies on other functions to handle all required endian-swapping and format conversion. <simplesect kind="see"><para>FIXME.</para></simplesect>
<simplesect kind="return"><para>true if the object wants to be called again with new data; false if no additional data is wanted. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_sample_handler.h" line="54"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Abstract function object called to handle received data blocks.</para><para>An object derived from this class is passed to <ref refid="classusrp2_1_1usrp2_1adc5c23804bb1277b89ec51c519275c42" kindref="member">usrp2::rx_samples</ref> to process the received frames of samples. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="16051">
        <label>usrp2::rx_nop_handler</label>
        <link refid="classusrp2_1_1rx__nop__handler"/>
        <childnode refid="16050" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16052">
        <label>rx_16sc_handler</label>
        <link refid="classrx__16sc__handler"/>
        <childnode refid="16051" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16050">
        <label>usrp2::rx_sample_handler</label>
        <link refid="classusrp2_1_1rx__sample__handler"/>
      </node>
      <node id="16053">
        <label>rx_32fc_handler</label>
        <link refid="classrx__32fc__handler"/>
        <childnode refid="16051" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_sample_handler.h" line="34" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_sample_handler.h" bodystart="34" bodyend="55"/>
    <listofallmembers>
      <member refid="classusrp2_1_1rx__sample__handler_1a6f603e963d9bc69ee5c8bb9ae79d9192" prot="public" virt="pure-virtual"><scope>usrp2::rx_sample_handler</scope><name>operator()</name></member>
      <member refid="classusrp2_1_1rx__sample__handler_1a014d9cd0873e8da27a952ffa756a96b9" prot="public" virt="virtual"><scope>usrp2::rx_sample_handler</scope><name>~rx_sample_handler</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>