Sophie

Sophie

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

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__nop__handler" kind="class" prot="public">
    <compoundname>usrp2::rx_nop_handler</compoundname>
    <basecompoundref refid="classusrp2_1_1rx__sample__handler" prot="public" virt="non-virtual">usrp2::rx_sample_handler</basecompoundref>
    <derivedcompoundref refid="classrx__16sc__handler" prot="public" virt="non-virtual">rx_16sc_handler</derivedcompoundref>
    <derivedcompoundref refid="classrx__32fc__handler" prot="public" virt="non-virtual">rx_32fc_handler</derivedcompoundref>
    <includes refid="rx__nop__handler_8h" local="no">rx_nop_handler.h</includes>
      <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classusrp2_1_1rx__nop__handler_1ab759acd1b6667096023c459c868e149e" prot="public" static="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref>&lt; <ref refid="classusrp2_1_1rx__nop__handler" kindref="compound">rx_nop_handler</ref> &gt;</type>
        <definition>typedef boost::shared_ptr&lt;rx_nop_handler&gt; usrp2::rx_nop_handler::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <reimplementedby refid="classrx__32fc__handler_1ab83dcaa97b0cf9a603d4498868899eb2">sptr</reimplementedby>
        <reimplementedby refid="classrx__16sc__handler_1ad0d74dd4756abee956d66945334befd5">sptr</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="53" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="53" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classusrp2_1_1rx__nop__handler_1a58cf56cfbbe829b9bf28a5505587417a" prot="private" static="no" mutable="no">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::d_max_samples</definition>
        <argsstring></argsstring>
        <name>d_max_samples</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="42" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1rx__nop__handler_1a09517ee252bd5571703d943343ad6c43" prot="private" static="no" mutable="no">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::d_max_quantum</definition>
        <argsstring></argsstring>
        <name>d_max_quantum</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="43" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="43" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1rx__nop__handler_1aea584fb882af3616f95f6e67a4d37f05" prot="private" static="no" mutable="no">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::d_nsamples</definition>
        <argsstring></argsstring>
        <name>d_nsamples</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="44" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="44" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classusrp2_1_1rx__nop__handler_1a8f45ebe2f59d7f64a8ae3b561707854f" prot="private" static="no" mutable="no">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::d_nframes</definition>
        <argsstring></argsstring>
        <name>d_nframes</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="45" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="45" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classusrp2_1_1rx__nop__handler_1a096e49b0d9e61cf9879dba483f90e1b5" prot="protected" static="no" mutable="no">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool usrp2::rx_nop_handler::d_err</definition>
        <argsstring></argsstring>
        <name>d_err</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="48" bodyend="-1"/>
        <referencedby refid="classusrp2_1_1rx__nop__handler_1a82c548ec3681324ae44d9b5e53186ed4" compoundref="rx__nop__handler_8h" startline="90" endline="90">has_errored_p</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1a64b6247c33859a63ec52fa5099a42f27" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>usrp2::rx_nop_handler::rx_nop_handler</definition>
        <argsstring>(uint64_t max_samples, uint64_t max_quantum=0)</argsstring>
        <name>rx_nop_handler</name>
        <param>
          <type>uint64_t</type>
          <declname>max_samples</declname>
        </param>
        <param>
          <type>uint64_t</type>
          <declname>max_quantum</declname>
          <defval>0</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Constructor</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>max_samples</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum number of samples to copy. Use zero for no maximum. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>max_quantum</parametername>
</parameternamelist>
<parameterdescription>
<para>Maximum number of samples required to accept in one call. Use 0 to indicate no maximum. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="64" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="62" bodyend="64"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1a1b266e1dde8c5edfb0075b46a014e9a7" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual usrp2::rx_nop_handler::~rx_nop_handler</definition>
        <argsstring>()</argsstring>
        <name>~rx_nop_handler</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Destructor. Derived classes must implement their own, non-inline destructor. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="69"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1a3efeecc3974a7a4c925962d82da51ea8" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::nframes</definition>
        <argsstring>() const </argsstring>
        <name>nframes</name>
        <briefdescription>
<para>Returns number of frames this copier was called with. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="74" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="74" bodyend="74"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1a2220061004f9e8b78103bfcce31b4407" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::nsamples</definition>
        <argsstring>() const </argsstring>
        <name>nsamples</name>
        <briefdescription>
<para>Returns actual number of samples copied. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="79" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="79" bodyend="79"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1af33e3810d1ac4a5fa8d1af7ed2656d03" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>uint64_t</type>
        <definition>uint64_t usrp2::rx_nop_handler::max_samples</definition>
        <argsstring>() const </argsstring>
        <name>max_samples</name>
        <briefdescription>
<para>Returns maximum number of samples that will be copied. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="84" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="84" bodyend="84"/>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1a82c548ec3681324ae44d9b5e53186ed4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool usrp2::rx_nop_handler::has_errored_p</definition>
        <argsstring>() const </argsstring>
        <name>has_errored_p</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Returns true if an error has occurred. Derived classes must set d_err to true when an error occurs in the () operator </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="90" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="90" bodyend="90"/>
        <references refid="classusrp2_1_1rx__nop__handler_1a096e49b0d9e61cf9879dba483f90e1b5" compoundref="rx__nop__handler_8h" startline="48">d_err</references>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1a1b4d4e698997a3ca9fd2fb9c71e93383" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool usrp2::rx_nop_handler::has_finished_p</definition>
        <argsstring>() const </argsstring>
        <name>has_finished_p</name>
        <briefdescription>
<para>Returns true if this instance has reached the maximum number of samples. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="96" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="95" bodyend="96"/>
        <referencedby refid="classusrp2_1_1rx__nop__handler_1aa274f87d6c1d8de9dc412e9c00b4d955" compoundref="rx__nop__handler_8h" startline="116" endline="125">operator()</referencedby>
      </memberdef>
      <memberdef kind="function" id="classusrp2_1_1rx__nop__handler_1aa274f87d6c1d8de9dc412e9c00b4d955" 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>virtual bool usrp2::rx_nop_handler::operator()</definition>
        <argsstring>(const uint32_t *items, size_t nitems, const rx_metadata *metadata)</argsstring>
        <name>operator()</name>
        <reimplements refid="classusrp2_1_1rx__sample__handler_1a6f603e963d9bc69ee5c8bb9ae79d9192">operator()</reimplements>
        <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>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/usrp2/host/include/usrp2/rx_nop_handler.h" line="117" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="116" bodyend="125"/>
        <references refid="classusrp2_1_1rx__nop__handler_1a1b4d4e698997a3ca9fd2fb9c71e93383" compoundref="rx__nop__handler_8h" startline="95" endline="96">has_finished_p</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="16044">
        <label>usrp2::rx_nop_handler</label>
        <link refid="classusrp2_1_1rx__nop__handler"/>
        <childnode refid="16045" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16046">
        <label>rx_16sc_handler</label>
        <link refid="classrx__16sc__handler"/>
        <childnode refid="16044" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16045">
        <label>usrp2::rx_sample_handler</label>
        <link refid="classusrp2_1_1rx__sample__handler"/>
      </node>
      <node id="16047">
        <label>rx_32fc_handler</label>
        <link refid="classrx__32fc__handler"/>
        <childnode refid="16044" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="16048">
        <label>usrp2::rx_nop_handler</label>
        <link refid="classusrp2_1_1rx__nop__handler"/>
        <childnode refid="16049" relation="public-inheritance">
        </childnode>
      </node>
      <node id="16049">
        <label>usrp2::rx_sample_handler</label>
        <link refid="classusrp2_1_1rx__sample__handler"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/rx_nop_handler.h" bodystart="40" bodyend="126"/>
    <listofallmembers>
      <member refid="classusrp2_1_1rx__nop__handler_1a096e49b0d9e61cf9879dba483f90e1b5" prot="protected" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>d_err</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a09517ee252bd5571703d943343ad6c43" prot="private" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>d_max_quantum</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a58cf56cfbbe829b9bf28a5505587417a" prot="private" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>d_max_samples</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a8f45ebe2f59d7f64a8ae3b561707854f" prot="private" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>d_nframes</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1aea584fb882af3616f95f6e67a4d37f05" prot="private" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>d_nsamples</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a82c548ec3681324ae44d9b5e53186ed4" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>has_errored_p</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a1b4d4e698997a3ca9fd2fb9c71e93383" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>has_finished_p</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1af33e3810d1ac4a5fa8d1af7ed2656d03" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>max_samples</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a3efeecc3974a7a4c925962d82da51ea8" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>nframes</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a2220061004f9e8b78103bfcce31b4407" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>nsamples</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1aa274f87d6c1d8de9dc412e9c00b4d955" prot="public" virt="virtual"><scope>usrp2::rx_nop_handler</scope><name>operator()</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a64b6247c33859a63ec52fa5099a42f27" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>rx_nop_handler</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1ab759acd1b6667096023c459c868e149e" prot="public" virt="non-virtual"><scope>usrp2::rx_nop_handler</scope><name>sptr</name></member>
      <member refid="classusrp2_1_1rx__nop__handler_1a1b266e1dde8c5edfb0075b46a014e9a7" prot="public" virt="virtual"><scope>usrp2::rx_nop_handler</scope><name>~rx_nop_handler</name></member>
      <member refid="classusrp2_1_1rx__sample__handler_1a014d9cd0873e8da27a952ffa756a96b9" prot="public" virt="virtual"><scope>usrp2::rx_nop_handler</scope><name>~rx_sample_handler</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>