<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU Radio 3.2.2 C++ API: microtune_xxxx_eval_board Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <div class="contents"> <h1>microtune_xxxx_eval_board Class Reference<br/> <small> [<a class="el" href="group__hardware.html">Misc Hardware Control</a>]</small> </h1><!-- doxytag: class="microtune_xxxx_eval_board" --> <p>abstract class for controlling microtune xxxx eval board <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="microtune__xxxx__eval__board_8h_source.html">microtune_xxxx_eval_board.h</a>></code></p> <div class="dynheader"> Inheritance diagram for microtune_xxxx_eval_board:</div> <div class="dynsection"> <div class="center"><img src="classmicrotune__xxxx__eval__board__inherit__graph.png" border="0" usemap="#microtune__xxxx__eval__board_inherit__map" alt="Inheritance graph"/></div> <map name="microtune__xxxx__eval__board_inherit__map" id="microtune__xxxx__eval__board_inherit__map"> <area shape="rect" id="node3" href="classmicrotune__4702__eval__board.html" title="control microtune 4702 eval board" alt="" coords="5,83,189,112"/><area shape="rect" id="node5" href="classmicrotune__4937__eval__board.html" title="control microtune 4937 eval board" alt="" coords="213,83,397,112"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classmicrotune__xxxx__eval__board-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#ad0effba516749e66b4bcd2d2da394d22">microtune_xxxx_eval_board</a> (int which_pp=0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a4f2924691c7683ed5263c53582961283">~microtune_xxxx_eval_board</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a7c33c3a304b3a3837aebe0b939795908">board_present_p</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">is the eval board present? <a href="#a7c33c3a304b3a3837aebe0b939795908"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#adb0dc9f8e36e6960d92993f46a6c6909">set_RF_AGC_voltage</a> (float volts)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">set RF and IF AGC control voltages ([0, 5] volts) <a href="#adb0dc9f8e36e6960d92993f46a6c6909"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#aa013afa53992233db6020ee1e973f486">set_IF_AGC_voltage</a> (float volts)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a309de3cd072b0414f2f76498d1536cf0">set_AGC</a> (float value_0_1000)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">set RF and IF AGC levels together (scale [0, 1000]) <a href="#a309de3cd072b0414f2f76498d1536cf0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#afc1ab59edaaba910a2351298cc4da462">set_RF_freq</a> (double freq, double *actual_freq)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">select RF frequency to be tuned to output frequency. <code>freq</code> is the requested frequency in Hz, <code>actual_freq</code> is set to the actual frequency tuned. It takes about 100 ms for the PLL to settle. <a href="#afc1ab59edaaba910a2351298cc4da462"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a559253e6340481426b5cc67e2c89973b">set_RF_freq</a> (double freq)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#aea5c168dd36594567dac976c6b308e98">pll_locked_p</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#acb8c57351294269244d6ce6269f230eb">get_output_freq</a> ()</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">ppio_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a61be9a0910599fbbdd4b0164b5453843">d_ppio</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">i2c_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a6fc807ce2050b39fa5bf887a657837ae">d_i2c</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmicrotune__xxxx.html">microtune_xxxx</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx__eval__board.html#a7734fb4f9c1e4843b149628c2c38d3a5">d_tuner</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>abstract class for controlling microtune xxxx eval board </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ad0effba516749e66b4bcd2d2da394d22"></a><!-- doxytag: member="microtune_xxxx_eval_board::microtune_xxxx_eval_board" ref="ad0effba516749e66b4bcd2d2da394d22" args="(int which_pp=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">microtune_xxxx_eval_board::microtune_xxxx_eval_board </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>which_pp</em> = <code>0</code></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4f2924691c7683ed5263c53582961283"></a><!-- doxytag: member="microtune_xxxx_eval_board::~microtune_xxxx_eval_board" ref="a4f2924691c7683ed5263c53582961283" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual microtune_xxxx_eval_board::~microtune_xxxx_eval_board </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a7c33c3a304b3a3837aebe0b939795908"></a><!-- doxytag: member="microtune_xxxx_eval_board::board_present_p" ref="a7c33c3a304b3a3837aebe0b939795908" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> microtune_xxxx_eval_board::board_present_p </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>is the eval board present? </p> </div> </div> <a class="anchor" id="acb8c57351294269244d6ce6269f230eb"></a><!-- doxytag: member="microtune_xxxx_eval_board::get_output_freq" ref="acb8c57351294269244d6ce6269f230eb" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double microtune_xxxx_eval_board::get_output_freq </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the output frequency (IF center freq) of the tuner in Hz. </dd></dl> </div> </div> <a class="anchor" id="aea5c168dd36594567dac976c6b308e98"></a><!-- doxytag: member="microtune_xxxx_eval_board::pll_locked_p" ref="aea5c168dd36594567dac976c6b308e98" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> microtune_xxxx_eval_board::pll_locked_p </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>true iff PLL is locked </dd></dl> </div> </div> <a class="anchor" id="a309de3cd072b0414f2f76498d1536cf0"></a><!-- doxytag: member="microtune_xxxx_eval_board::set_AGC" ref="a309de3cd072b0414f2f76498d1536cf0" args="(float value_0_1000)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void microtune_xxxx_eval_board::set_AGC </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>value_0_1000</em></td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>set RF and IF AGC levels together (scale [0, 1000]) </p> <p>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. </p> <p>Implemented in <a class="el" href="classmicrotune__4702__eval__board.html#a5e98afa535aa856d472b9448d77de908">microtune_4702_eval_board</a>, and <a class="el" href="classmicrotune__4937__eval__board.html#a146c33244133af23d28dd9a76863d53f">microtune_4937_eval_board</a>.</p> </div> </div> <a class="anchor" id="aa013afa53992233db6020ee1e973f486"></a><!-- doxytag: member="microtune_xxxx_eval_board::set_IF_AGC_voltage" ref="aa013afa53992233db6020ee1e973f486" args="(float volts)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void microtune_xxxx_eval_board::set_IF_AGC_voltage </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>volts</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="adb0dc9f8e36e6960d92993f46a6c6909"></a><!-- doxytag: member="microtune_xxxx_eval_board::set_RF_AGC_voltage" ref="adb0dc9f8e36e6960d92993f46a6c6909" args="(float volts)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void microtune_xxxx_eval_board::set_RF_AGC_voltage </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>volts</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>set RF and IF AGC control voltages ([0, 5] volts) </p> </div> </div> <a class="anchor" id="a559253e6340481426b5cc67e2c89973b"></a><!-- doxytag: member="microtune_xxxx_eval_board::set_RF_freq" ref="a559253e6340481426b5cc67e2c89973b" args="(double freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double microtune_xxxx_eval_board::set_RF_freq </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>freq</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="afc1ab59edaaba910a2351298cc4da462"></a><!-- doxytag: member="microtune_xxxx_eval_board::set_RF_freq" ref="afc1ab59edaaba910a2351298cc4da462" args="(double freq, double *actual_freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> microtune_xxxx_eval_board::set_RF_freq </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"> <em>actual_freq</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>select RF frequency to be tuned to output frequency. <code>freq</code> is the requested frequency in Hz, <code>actual_freq</code> is set to the actual frequency tuned. It takes about 100 ms for the PLL to settle. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true iff sucessful. </dd></dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a6fc807ce2050b39fa5bf887a657837ae"></a><!-- doxytag: member="microtune_xxxx_eval_board::d_i2c" ref="a6fc807ce2050b39fa5bf887a657837ae" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">i2c_sptr</a> <a class="el" href="classmicrotune__xxxx__eval__board.html#a6fc807ce2050b39fa5bf887a657837ae">microtune_xxxx_eval_board::d_i2c</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a61be9a0910599fbbdd4b0164b5453843"></a><!-- doxytag: member="microtune_xxxx_eval_board::d_ppio" ref="a61be9a0910599fbbdd4b0164b5453843" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">ppio_sptr</a> <a class="el" href="classmicrotune__xxxx__eval__board.html#a61be9a0910599fbbdd4b0164b5453843">microtune_xxxx_eval_board::d_ppio</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a7734fb4f9c1e4843b149628c2c38d3a5"></a><!-- doxytag: member="microtune_xxxx_eval_board::d_tuner" ref="a7734fb4f9c1e4843b149628c2c38d3a5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classmicrotune__xxxx.html">microtune_xxxx</a>* <a class="el" href="classmicrotune__xxxx__eval__board.html#a7734fb4f9c1e4843b149628c2c38d3a5">microtune_xxxx_eval_board::d_tuner</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="microtune__xxxx__eval__board_8h_source.html">microtune_xxxx_eval_board.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>