Sophie

Sophie

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

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="namespaceusrp2" kind="namespace">
    <compoundname>usrp2</compoundname>
    <innerclass refid="classusrp2_1_1copy__handler" prot="public">usrp2::copy_handler</innerclass>
    <innerclass refid="classusrp2_1_1data__handler" prot="public">usrp2::data_handler</innerclass>
    <innerclass refid="structusrp2_1_1rx__metadata" prot="public">usrp2::rx_metadata</innerclass>
    <innerclass refid="structusrp2_1_1tx__metadata" prot="public">usrp2::tx_metadata</innerclass>
    <innerclass refid="classusrp2_1_1rx__nop__handler" prot="public">usrp2::rx_nop_handler</innerclass>
    <innerclass refid="classusrp2_1_1rx__sample__handler" prot="public">usrp2::rx_sample_handler</innerclass>
    <innerclass refid="classusrp2_1_1tune__result" prot="public">usrp2::tune_result</innerclass>
    <innerclass refid="structusrp2_1_1props" prot="public">usrp2::props</innerclass>
    <innerclass refid="classusrp2_1_1usrp2" prot="public">usrp2::usrp2</innerclass>
    <innerclass refid="structusrp2_1_1op__generic__cmd" prot="public">usrp2::op_generic_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__config__rx__v2__cmd" prot="public">usrp2::op_config_rx_v2_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__start__rx__streaming__cmd" prot="public">usrp2::op_start_rx_streaming_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__stop__rx__cmd" prot="public">usrp2::op_stop_rx_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__config__tx__v2__cmd" prot="public">usrp2::op_config_tx_v2_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__config__mimo__cmd" prot="public">usrp2::op_config_mimo_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__burn__mac__addr__cmd" prot="public">usrp2::op_burn_mac_addr_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__dboard__info__cmd" prot="public">usrp2::op_dboard_info_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__peek__cmd" prot="public">usrp2::op_peek_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__poke__cmd" prot="public">usrp2::op_poke_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__freq__cmd" prot="public">usrp2::op_freq_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__gpio__cmd" prot="public">usrp2::op_gpio_cmd</innerclass>
    <innerclass refid="structusrp2_1_1op__gpio__set__sels__cmd" prot="public">usrp2::op_gpio_set_sels_cmd</innerclass>
    <innerclass refid="classusrp2_1_1pending__reply" prot="public">usrp2::pending_reply</innerclass>
    <innerclass refid="classusrp2_1_1eth__buffer" prot="public">usrp2::eth_buffer</innerclass>
    <innerclass refid="classusrp2_1_1ethernet" prot="public">usrp2::ethernet</innerclass>
    <innerclass refid="classusrp2_1_1pktfilter" prot="public">usrp2::pktfilter</innerclass>
    <innerclass refid="classusrp2_1_1ring" prot="public">usrp2::ring</innerclass>
    <innerclass refid="structusrp2_1_1db__info" prot="public">usrp2::db_info</innerclass>
    <innerclass refid="classusrp2_1_1usrp2__thread" prot="public">usrp2::usrp2_thread</innerclass>
      <sectiondef kind="enum">
      <memberdef kind="enum" id="namespaceusrp2_1acd2bc44df75984cf010803436e216257" prot="public" static="no">
        <name>eth_flags</name>
        <enumvalue id="namespaceusrp2_1acd2bc44df75984cf010803436e216257a704b5a40c2bc2b6e59cb82797f698dc8" prot="public">
          <name>EF_DONTWAIT</name>
          <initializer> 0x0001</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/eth_common.h" line="29" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/eth_common.h" bodystart="29" bodyend="31"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="typedef">
      <memberdef kind="typedef" id="namespaceusrp2_1ac62f049aabfc471bbf3c03890efe46e9" prot="public" static="no">
        <type>uint32_t</type>
        <definition>typedef uint32_t usrp2::fpga_timestamp</definition>
        <argsstring></argsstring>
        <name>fpga_timestamp</name>
        <briefdescription>
<para>type of the timestamp returned from the USRP2 FPGA </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/metadata.h" line="26" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/metadata.h" bodystart="26" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="namespaceusrp2_1a7315b3af141f8f86dbae5bc9a059418b" prot="public" static="no">
        <type><ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; <ref refid="structusrp2_1_1props" kindref="compound">props</ref> &gt;</type>
        <definition>typedef std::vector&lt;props&gt; usrp2::props_vector_t</definition>
        <argsstring></argsstring>
        <name>props_vector_t</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" bodystart="51" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="namespaceusrp2_1acc325cbcd9508ce60db68c2136697ef3" prot="public" static="no">
        <type>struct iovec</type>
        <definition>typedef struct iovec usrp2::eth_iovec</definition>
        <argsstring></argsstring>
        <name>eth_iovec</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/eth_common.h" line="33" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/eth_common.h" bodystart="33" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespaceusrp2_1a2e9e3b8c019e7246fd6e156823501f2b" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::_MC_WE_LOCK</definition>
        <argsstring></argsstring>
        <name>_MC_WE_LOCK</name>
        <initializer> 0x0001</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" line="28" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" bodystart="28" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1a252aefd24de02bd4fae0708945148c06" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::_MC_MIMO_CLK_INPUT</definition>
        <argsstring></argsstring>
        <name>_MC_MIMO_CLK_INPUT</name>
        <initializer> 0x0002</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" line="29" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" bodystart="29" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1ad25e95f575d5d8d5ae477886d441488a" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::MC_WE_DONT_LOCK</definition>
        <argsstring></argsstring>
        <name>MC_WE_DONT_LOCK</name>
        <initializer> 0x0000</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" line="37" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" bodystart="37" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1a064ca7594827b10576735d2f61155647" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::MC_WE_LOCK_TO_SMA</definition>
        <argsstring></argsstring>
        <name>MC_WE_LOCK_TO_SMA</name>
        <initializer> (_MC_WE_LOCK | 0)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" bodystart="38" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1ab7876a98b1067bcc9ec1c57a89ec3692" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::MC_WE_LOCK_TO_MIMO</definition>
        <argsstring></argsstring>
        <name>MC_WE_LOCK_TO_MIMO</name>
        <initializer> (_MC_WE_LOCK | _MC_MIMO_CLK_INPUT)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" line="39" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" bodystart="39" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1ad67e03569353e34e0644d7ec33cc0237" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::MC_PROVIDE_CLK_TO_MIMO</definition>
        <argsstring></argsstring>
        <name>MC_PROVIDE_CLK_TO_MIMO</name>
        <initializer> 0x0004</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" line="47" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/mimo_config.h" bodystart="47" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1aa3e85fb71065c511a14325e826bdf8b2" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::GPIO_TX_BANK</definition>
        <argsstring></argsstring>
        <name>GPIO_TX_BANK</name>
        <initializer> 0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" line="68" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" bodystart="68" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespaceusrp2_1a1dabb89e3c9a9c3b6c45d9c1a89f6930" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int usrp2::GPIO_RX_BANK</definition>
        <argsstring></argsstring>
        <name>GPIO_RX_BANK</name>
        <initializer> 1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" line="69" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" bodystart="69" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespaceusrp2_1ac22b2273e2a32dc7a2c3cc433e00a326" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void usrp2::copy_u2_16sc_to_host_16sc</definition>
        <argsstring>(size_t nitems, const uint32_t *items, std::complex&lt; int16_t &gt; *host_items)</argsstring>
        <name>copy_u2_16sc_to_host_16sc</name>
        <param>
          <type>size_t</type>
          <declname>nitems</declname>
        </param>
        <param>
          <type>const uint32_t *</type>
          <declname>items</declname>
        </param>
        <param>
          <type>std::complex&lt; int16_t &gt; *</type>
          <declname>host_items</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/copiers.h" line="38"/>
      </memberdef>
      <memberdef kind="function" id="namespaceusrp2_1ac06cf2588da630a2cb7f09034d9180ef" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void usrp2::copy_u2_16sc_to_host_32fc</definition>
        <argsstring>(size_t nitems, const uint32_t *items, std::complex&lt; float &gt; *host_items)</argsstring>
        <name>copy_u2_16sc_to_host_32fc</name>
        <param>
          <type>size_t</type>
          <declname>nitems</declname>
        </param>
        <param>
          <type>const uint32_t *</type>
          <declname>items</declname>
        </param>
        <param>
          <type>std::complex&lt; float &gt; *</type>
          <declname>host_items</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/copiers.h" line="43"/>
      </memberdef>
      <memberdef kind="function" id="namespaceusrp2_1ad4212df920d8e992bca65826e7b48c3b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void usrp2::copy_host_16sc_to_u2_16sc</definition>
        <argsstring>(size_t nitems, const std::complex&lt; int16_t &gt; *host_items, uint32_t *items)</argsstring>
        <name>copy_host_16sc_to_u2_16sc</name>
        <param>
          <type>size_t</type>
          <declname>nitems</declname>
        </param>
        <param>
          <type>const std::complex&lt; int16_t &gt; *</type>
          <declname>host_items</declname>
        </param>
        <param>
          <type>uint32_t *</type>
          <declname>items</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/copiers.h" line="54"/>
      </memberdef>
      <memberdef kind="function" id="namespaceusrp2_1abafc9d97d1b2c3ef8ea1ffad18a70c76" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void usrp2::copy_host_32fc_to_u2_16sc</definition>
        <argsstring>(size_t nitems, const std::complex&lt; float &gt; *host_items, uint32_t *items)</argsstring>
        <name>copy_host_32fc_to_u2_16sc</name>
        <param>
          <type>size_t</type>
          <declname>nitems</declname>
        </param>
        <param>
          <type>const std::complex&lt; float &gt; *</type>
          <declname>host_items</declname>
        </param>
        <param>
          <type>uint32_t *</type>
          <declname>items</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/copiers.h" line="59"/>
      </memberdef>
      <memberdef kind="function" id="namespaceusrp2_1a6c97d2144f6ea49f2db08ab3ecec345c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classstd_1_1vector" kindref="compound">props_vector_t</ref></type>
        <definition>props_vector_t usrp2::find</definition>
        <argsstring>(const std::string &amp;ifc, const std::string &amp;mac_addr=&quot;&quot;)</argsstring>
        <name>find</name>
        <param>
          <type>const std::string &amp;</type>
          <declname>ifc</declname>
        </param>
        <param>
          <type>const std::string &amp;</type>
          <declname>mac_addr</declname>
          <defval>&quot;&quot;</defval>
        </param>
        <briefdescription>
<para>Search the ethernet for all USRP2s or for a specific USRP2. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ifc</parametername>
</parameternamelist>
<parameterdescription>
<para>is the name of the OS ethernet interface (e.g., &quot;eth0&quot;) </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>mac_addr</parametername>
</parameternamelist>
<parameterdescription>
<para>is the MAC address of the desired USRP2, or &quot;&quot; to search for all. mac_addr must be either a zero length string, &quot;&quot;, or must be of the form &quot;01:02:03:04:05:06&quot; or &quot;05:06&quot;.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>a vector of properties, 1 entry for each matching USRP2 found. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/usrp2.h" line="63"/>
      </memberdef>
      <memberdef kind="function" id="namespaceusrp2_1a7e59919af39610da9ca268b3abe6028f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int usrp2::open_usrp2_socket</definition>
        <argsstring>()</argsstring>
        <name>open_usrp2_socket</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Return the result of executing:</para><para>int fd = socket(PF_PACKET, SOCK_RAW, htons(0xBEEF));</para><para>Doing it in a way that we don&apos;t need to be running as root. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/lib/open_usrp2_socket.h" line="30"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>Base class for receive handlers that must copy into potentially limited range destination buffers.</para><para>Maintains counters for number of items copied, times invoked, and test for whether maximum has been reached.</para><para>Derived classes should override the () operator, but call this parent class method at some point at the start of their own operations. </para>    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/usrp2/host/include/usrp2/copiers.h" line="25"/>
  </compounddef>
</doxygen>