Sophie

Sophie

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

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="classmicrotune__xxxx__eval__board" kind="class" prot="public">
    <compoundname>microtune_xxxx_eval_board</compoundname>
    <derivedcompoundref refid="classmicrotune__4702__eval__board" prot="public" virt="non-virtual">microtune_4702_eval_board</derivedcompoundref>
    <derivedcompoundref refid="classmicrotune__4937__eval__board" prot="public" virt="non-virtual">microtune_4937_eval_board</derivedcompoundref>
    <includes refid="microtune__xxxx__eval__board_8h" local="no">microtune_xxxx_eval_board.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classmicrotune__xxxx__eval__board_1a61be9a0910599fbbdd4b0164b5453843" prot="protected" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">ppio_sptr</ref></type>
        <definition>ppio_sptr microtune_xxxx_eval_board::d_ppio</definition>
        <argsstring></argsstring>
        <name>d_ppio</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="92" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" bodystart="92" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmicrotune__xxxx__eval__board_1a6fc807ce2050b39fa5bf887a657837ae" prot="protected" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">i2c_sptr</ref></type>
        <definition>i2c_sptr microtune_xxxx_eval_board::d_i2c</definition>
        <argsstring></argsstring>
        <name>d_i2c</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="93" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" bodystart="93" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmicrotune__xxxx__eval__board_1a7734fb4f9c1e4843b149628c2c38d3a5" prot="protected" static="no" mutable="no">
        <type><ref refid="classmicrotune__xxxx" kindref="compound">microtune_xxxx</ref> *</type>
        <definition>microtune_xxxx* microtune_xxxx_eval_board::d_tuner</definition>
        <argsstring></argsstring>
        <name>d_tuner</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="94" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" bodystart="94" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1ad0effba516749e66b4bcd2d2da394d22" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>microtune_xxxx_eval_board::microtune_xxxx_eval_board</definition>
        <argsstring>(int which_pp=0)</argsstring>
        <name>microtune_xxxx_eval_board</name>
        <param>
          <type>int</type>
          <declname>which_pp</declname>
          <defval>0</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="42"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1a4f2924691c7683ed5263c53582961283" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual microtune_xxxx_eval_board::~microtune_xxxx_eval_board</definition>
        <argsstring>()</argsstring>
        <name>~microtune_xxxx_eval_board</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="43"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1a7c33c3a304b3a3837aebe0b939795908" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool microtune_xxxx_eval_board::board_present_p</definition>
        <argsstring>()</argsstring>
        <name>board_present_p</name>
        <briefdescription>
<para>is the eval board present? </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="46"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1adb0dc9f8e36e6960d92993f46a6c6909" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void microtune_xxxx_eval_board::set_RF_AGC_voltage</definition>
        <argsstring>(float volts)</argsstring>
        <name>set_RF_AGC_voltage</name>
        <param>
          <type>float</type>
          <declname>volts</declname>
        </param>
        <briefdescription>
<para>set RF and IF AGC control voltages ([0, 5] volts) </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="51"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1aa013afa53992233db6020ee1e973f486" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void microtune_xxxx_eval_board::set_IF_AGC_voltage</definition>
        <argsstring>(float volts)</argsstring>
        <name>set_IF_AGC_voltage</name>
        <param>
          <type>float</type>
          <declname>volts</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="52"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1a309de3cd072b0414f2f76498d1536cf0" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void microtune_xxxx_eval_board::set_AGC</definition>
        <argsstring>(float value_0_1000)=0</argsstring>
        <name>set_AGC</name>
        <reimplementedby refid="classmicrotune__4937__eval__board_1a146c33244133af23d28dd9a76863d53f">set_AGC</reimplementedby>
        <reimplementedby refid="classmicrotune__4702__eval__board_1a5e98afa535aa856d472b9448d77de908">set_AGC</reimplementedby>
        <param>
          <type>float</type>
          <declname>value_0_1000</declname>
        </param>
        <briefdescription>
<para>set RF and IF AGC levels together (scale [0, 1000]) </para>        </briefdescription>
        <detaileddescription>
<para>This provides a simple linear interface for adjusting both the RF and IF gain in consort. This is the easy to use interface. 0 corresponds to minimum gain. 1000 corresponds to maximum gain. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="61"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1afc1ab59edaaba910a2351298cc4da462" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool microtune_xxxx_eval_board::set_RF_freq</definition>
        <argsstring>(double freq, double *actual_freq)</argsstring>
        <name>set_RF_freq</name>
        <param>
          <type>double</type>
          <declname>freq</declname>
        </param>
        <param>
          <type>double *</type>
          <declname>actual_freq</declname>
        </param>
        <briefdescription>
<para>select RF frequency to be tuned to output frequency. <computeroutput>freq</computeroutput> is the requested frequency in Hz, <computeroutput>actual_freq</computeroutput> is set to the actual frequency tuned. It takes about 100 ms for the PLL to settle. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>true iff sucessful. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="71"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1a559253e6340481426b5cc67e2c89973b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>double</type>
        <definition>double microtune_xxxx_eval_board::set_RF_freq</definition>
        <argsstring>(double freq)</argsstring>
        <name>set_RF_freq</name>
        <param>
          <type>double</type>
          <declname>freq</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="74"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1aea5c168dd36594567dac976c6b308e98" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool microtune_xxxx_eval_board::pll_locked_p</definition>
        <argsstring>()</argsstring>
        <name>pll_locked_p</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>true iff PLL is locked </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="79"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1acb8c57351294269244d6ce6269f230eb" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>double</type>
        <definition>double microtune_xxxx_eval_board::get_output_freq</definition>
        <argsstring>()</argsstring>
        <name>get_output_freq</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>the output frequency (IF center freq) of the tuner in Hz. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="84"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1a954b8910ed7f25102a4184363520e6ef" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void microtune_xxxx_eval_board::write_dac</definition>
        <argsstring>(int which, int value)</argsstring>
        <name>write_dac</name>
        <param>
          <type>int</type>
          <declname>which</declname>
        </param>
        <param>
          <type>int</type>
          <declname>value</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="88"/>
      </memberdef>
      <memberdef kind="function" id="classmicrotune__xxxx__eval__board_1ad851b7f020220283207210ae0d547116" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void microtune_xxxx_eval_board::write_both_dacs</definition>
        <argsstring>(int val0, int val1)</argsstring>
        <name>write_both_dacs</name>
        <param>
          <type>int</type>
          <declname>val0</declname>
        </param>
        <param>
          <type>int</type>
          <declname>val1</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="89"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>abstract class for controlling microtune xxxx eval board </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="15543">
        <label>microtune_4937_eval_board</label>
        <link refid="classmicrotune__4937__eval__board"/>
        <childnode refid="15541" relation="public-inheritance">
        </childnode>
      </node>
      <node id="15541">
        <label>microtune_xxxx_eval_board</label>
        <link refid="classmicrotune__xxxx__eval__board"/>
      </node>
      <node id="15542">
        <label>microtune_4702_eval_board</label>
        <link refid="classmicrotune__4702__eval__board"/>
        <childnode refid="15541" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="15545">
        <label>microtune_xxxx</label>
        <link refid="classmicrotune__xxxx"/>
      </node>
      <node id="15544">
        <label>microtune_xxxx_eval_board</label>
        <link refid="classmicrotune__xxxx__eval__board"/>
        <childnode refid="15545" relation="usage">
          <edgelabel>d_tuner</edgelabel>
        </childnode>
        <childnode refid="15546" relation="usage">
          <edgelabel>d_i2c</edgelabel>
        </childnode>
        <childnode refid="15548" relation="usage">
          <edgelabel>d_ppio</edgelabel>
        </childnode>
      </node>
      <node id="15546">
        <label>boost::shared_ptr&lt; i2c &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="15547" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="15547">
        <label>i2c</label>
        <link refid="classi2c"/>
      </node>
      <node id="15549">
        <label>ppio</label>
        <link refid="classppio"/>
      </node>
      <node id="15548">
        <label>boost::shared_ptr&lt; ppio &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="15549" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" line="40" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h" bodystart="40" bodyend="95"/>
    <listofallmembers>
      <member refid="classmicrotune__xxxx__eval__board_1a7c33c3a304b3a3837aebe0b939795908" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>board_present_p</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a6fc807ce2050b39fa5bf887a657837ae" prot="protected" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>d_i2c</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a61be9a0910599fbbdd4b0164b5453843" prot="protected" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>d_ppio</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a7734fb4f9c1e4843b149628c2c38d3a5" prot="protected" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>d_tuner</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1acb8c57351294269244d6ce6269f230eb" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>get_output_freq</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1ad0effba516749e66b4bcd2d2da394d22" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>microtune_xxxx_eval_board</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1aea5c168dd36594567dac976c6b308e98" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>pll_locked_p</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a309de3cd072b0414f2f76498d1536cf0" prot="public" virt="pure-virtual"><scope>microtune_xxxx_eval_board</scope><name>set_AGC</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1aa013afa53992233db6020ee1e973f486" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>set_IF_AGC_voltage</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1adb0dc9f8e36e6960d92993f46a6c6909" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>set_RF_AGC_voltage</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1afc1ab59edaaba910a2351298cc4da462" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>set_RF_freq</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a559253e6340481426b5cc67e2c89973b" prot="public" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>set_RF_freq</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1ad851b7f020220283207210ae0d547116" prot="private" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>write_both_dacs</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a954b8910ed7f25102a4184363520e6ef" prot="private" virt="non-virtual"><scope>microtune_xxxx_eval_board</scope><name>write_dac</name></member>
      <member refid="classmicrotune__xxxx__eval__board_1a4f2924691c7683ed5263c53582961283" prot="public" virt="virtual"><scope>microtune_xxxx_eval_board</scope><name>~microtune_xxxx_eval_board</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>