Sophie

Sophie

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

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="classrx__16sc__handler" kind="class" prot="public">
    <compoundname>rx_16sc_handler</compoundname>
    <basecompoundref refid="classusrp2_1_1rx__nop__handler" prot="public" virt="non-virtual">usrp2::rx_nop_handler</basecompoundref>
    <includes refid="rx__16sc__handler_8h" local="no">rx_16sc_handler.h</includes>
      <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classrx__16sc__handler_1ad0d74dd4756abee956d66945334befd5" prot="public" static="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref>&lt; <ref refid="classrx__16sc__handler" kindref="compound">rx_16sc_handler</ref> &gt;</type>
        <definition>typedef boost::shared_ptr&lt;rx_16sc_handler&gt; rx_16sc_handler::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <reimplements refid="classusrp2_1_1rx__nop__handler_1ab759acd1b6667096023c459c868e149e">sptr</reimplements>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" line="39" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" bodystart="39" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classrx__16sc__handler_1a127df76f01972ca9fd7af9e34b031a71" prot="private" static="no" mutable="no">
        <type>std::complex&lt; int16_t &gt; *</type>
        <definition>std::complex&lt;int16_t&gt;* rx_16sc_handler::d_dest</definition>
        <argsstring></argsstring>
        <name>d_dest</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" line="31" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" bodystart="31" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classrx__16sc__handler_1ae6fe07243aeb29c07713177991be5399" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>rx_16sc_handler::rx_16sc_handler</definition>
        <argsstring>(uint64_t max_samples, uint64_t max_quantum, std::complex&lt; int16_t &gt; *dest)</argsstring>
        <name>rx_16sc_handler</name>
        <param>
          <type>uint64_t</type>
          <declname>max_samples</declname>
        </param>
        <param>
          <type>uint64_t</type>
          <declname>max_quantum</declname>
        </param>
        <param>
          <type>std::complex&lt; int16_t &gt; *</type>
          <declname>dest</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" line="35" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" bodystart="34" bodyend="35"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classrx__16sc__handler_1af1568521f7705126c00759462a0d805a" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">sptr</ref></type>
        <definition>static sptr rx_16sc_handler::make</definition>
        <argsstring>(uint64_t max_samples, uint64_t max_quantum, std::complex&lt; int16_t &gt; *dest)</argsstring>
        <name>make</name>
        <param>
          <type>uint64_t</type>
          <declname>max_samples</declname>
        </param>
        <param>
          <type>uint64_t</type>
          <declname>max_quantum</declname>
        </param>
        <param>
          <type>std::complex&lt; int16_t &gt; *</type>
          <declname>dest</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" line="43" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" bodystart="42" bodyend="45"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classrx__16sc__handler_1aa64777749da89a212b1e07d96c5e44fb" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool rx_16sc_handler::operator()</definition>
        <argsstring>(const uint32_t *items, size_t nitems, const usrp2::rx_metadata *metadata)</argsstring>
        <name>operator()</name>
        <reimplements refid="classusrp2_1_1rx__nop__handler_1aa274f87d6c1d8de9dc412e9c00b4d955">operator()</reimplements>
        <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">usrp2::rx_metadata</ref> *</type>
          <declname>metadata</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Function operator invoked by USRP2 RX API. Derived classes must override this method but then invoke it at the start of their processing. This operator will always be called at least once.</para><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><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/gr-usrp2/src/rx_16sc_handler.h" line="49" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" bodystart="48" bodyend="58"/>
      </memberdef>
      <memberdef kind="function" id="classrx__16sc__handler_1a7d10ed4ee290250526b4aea37fb78a30" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>rx_16sc_handler::~rx_16sc_handler</definition>
        <argsstring>()</argsstring>
        <name>~rx_16sc_handler</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" line="60"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="16029">
        <label>usrp2::rx_nop_handler</label>
        <link refid="classusrp2_1_1rx__nop__handler"/>
        <childnode refid="16030" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16028">
        <label>rx_16sc_handler</label>
        <link refid="classrx__16sc__handler"/>
        <childnode refid="16029" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16030">
        <label>usrp2::rx_sample_handler</label>
        <link refid="classusrp2_1_1rx__sample__handler"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="16032">
        <label>usrp2::rx_nop_handler</label>
        <link refid="classusrp2_1_1rx__nop__handler"/>
        <childnode refid="16033" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16031">
        <label>rx_16sc_handler</label>
        <link refid="classrx__16sc__handler"/>
        <childnode refid="16032" relation="public-inheritance">
        </childnode>
        <childnode refid="16034" relation="usage">
          <edgelabel>d_dest</edgelabel>
        </childnode>
      </node>
      <node id="16033">
        <label>usrp2::rx_sample_handler</label>
        <link refid="classusrp2_1_1rx__sample__handler"/>
      </node>
      <node id="16034">
        <label>std::complex&lt; int16_t &gt;</label>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" line="30" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gr-usrp2/src/rx_16sc_handler.h" bodystart="29" bodyend="61"/>
    <listofallmembers>
      <member refid="classrx__16sc__handler_1a127df76f01972ca9fd7af9e34b031a71" prot="private" virt="non-virtual"><scope>rx_16sc_handler</scope><name>d_dest</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a096e49b0d9e61cf9879dba483f90e1b5" prot="protected" virt="non-virtual"><scope>rx_16sc_handler</scope><name>d_err</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a82c548ec3681324ae44d9b5e53186ed4" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>has_errored_p</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a1b4d4e698997a3ca9fd2fb9c71e93383" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>has_finished_p</name></member>
      <member refid="classrx__16sc__handler_1af1568521f7705126c00759462a0d805a" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>make</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1af33e3810d1ac4a5fa8d1af7ed2656d03" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>max_samples</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a3efeecc3974a7a4c925962d82da51ea8" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>nframes</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a2220061004f9e8b78103bfcce31b4407" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>nsamples</name></member>
      <member refid="classrx__16sc__handler_1aa64777749da89a212b1e07d96c5e44fb" prot="public" virt="virtual"><scope>rx_16sc_handler</scope><name>operator()</name></member>
      <member refid="classrx__16sc__handler_1ae6fe07243aeb29c07713177991be5399" prot="private" virt="non-virtual"><scope>rx_16sc_handler</scope><name>rx_16sc_handler</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a64b6247c33859a63ec52fa5099a42f27" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>rx_nop_handler</name></member>
      <member refid="classrx__16sc__handler_1ad0d74dd4756abee956d66945334befd5" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>sptr</name></member>
      <member refid="classrx__16sc__handler_1a7d10ed4ee290250526b4aea37fb78a30" prot="public" virt="non-virtual"><scope>rx_16sc_handler</scope><name>~rx_16sc_handler</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a1b266e1dde8c5edfb0075b46a014e9a7" prot="public" virt="virtual"><scope>rx_16sc_handler</scope><name>~rx_nop_handler</name></member>
      <member refid="classusrp2_1_1rx__sample__handler_1a014d9cd0873e8da27a952ffa756a96b9" prot="public" virt="virtual"><scope>rx_16sc_handler</scope><name>~rx_sample_handler</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>