<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: microtune_xxxx Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classmicrotune__xxxx.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmicrotune__xxxx-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">microtune_xxxx Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>abstract class for controlling microtune {4937,4702} tuner modules
<a href="classmicrotune__xxxx.html#details">More...</a></p>
<p><code>#include <<a class="el" href="microtune__xxxx_8h_source.html">microtune_xxxx.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for microtune_xxxx:</div>
<div class="dyncontent">
<div class="center"><img src="classmicrotune__xxxx__inherit__graph.png" border="0" usemap="#microtune__xxxx_inherit__map" alt="Inheritance graph"/></div>
<map name="microtune__xxxx_inherit__map" id="microtune__xxxx_inherit__map">
<area shape="rect" id="node3" href="classmicrotune__4702.html" title="class for controlling microtune 4702 tuner module" alt="" coords="5,80,120,107"/><area shape="rect" id="node5" href="classmicrotune__4937.html" title="class for controlling microtune 4937 tuner module" alt="" coords="144,80,259,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0b1644c14ab5ad28eeb29301cceb68ff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a0b1644c14ab5ad28eeb29301cceb68ff">microtune_xxxx</a> ()</td></tr>
<tr class="separator:a0b1644c14ab5ad28eeb29301cceb68ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1dd4385969182a435cc3f0d254503df"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#af1dd4385969182a435cc3f0d254503df">~microtune_xxxx</a> ()</td></tr>
<tr class="separator:af1dd4385969182a435cc3f0d254503df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76ecad84f1f57ce34585056b18ac8d99"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a76ecad84f1f57ce34585056b18ac8d99">set_RF_freq</a> (double freq, double *actual_freq)=0</td></tr>
<tr class="memdesc:a76ecad84f1f57ce34585056b18ac8d99"><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="#a76ecad84f1f57ce34585056b18ac8d99"></a><br/></td></tr>
<tr class="separator:a76ecad84f1f57ce34585056b18ac8d99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7cf6ff57a511f70662f02f303dcef0e1"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a7cf6ff57a511f70662f02f303dcef0e1">set_RF_freq</a> (double freq)</td></tr>
<tr class="separator:a7cf6ff57a511f70662f02f303dcef0e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28ce9c429b571c70a7fa41dd07d11b9a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a28ce9c429b571c70a7fa41dd07d11b9a">pll_locked_p</a> ()=0</td></tr>
<tr class="separator:a28ce9c429b571c70a7fa41dd07d11b9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2f4da6893763446700314258495d8cc"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#ad2f4da6893763446700314258495d8cc">get_output_freq</a> ()=0</td></tr>
<tr class="separator:ad2f4da6893763446700314258495d8cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>abstract class for controlling microtune {4937,4702} tuner modules </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0b1644c14ab5ad28eeb29301cceb68ff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">microtune_xxxx::microtune_xxxx </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af1dd4385969182a435cc3f0d254503df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual microtune_xxxx::~microtune_xxxx </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad2f4da6893763446700314258495d8cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double microtune_xxxx::get_output_freq </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the output frequency (IF center freq) of the tuner in Hz. </dd></dl>
<p>Implemented in <a class="el" href="classmicrotune__4702.html#af39ce035b569a357df81e8b460998d47">microtune_4702</a>, and <a class="el" href="classmicrotune__4937.html#a02613c15713ccb19805140c1911e4443">microtune_4937</a>.</p>
</div>
</div>
<a class="anchor" id="a28ce9c429b571c70a7fa41dd07d11b9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool microtune_xxxx::pll_locked_p </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true iff PLL is locked </dd></dl>
<p>Implemented in <a class="el" href="classmicrotune__4702.html#a096b82e283df729ea282f8ceaaca55b7">microtune_4702</a>, and <a class="el" href="classmicrotune__4937.html#a0f5ec2bcbbf7120900ce12c87d15dc95">microtune_4937</a>.</p>
</div>
</div>
<a class="anchor" id="a76ecad84f1f57ce34585056b18ac8d99"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool microtune_xxxx::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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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="section return"><dt>Returns</dt><dd>true iff sucessful. </dd></dl>
<p>Implemented in <a class="el" href="classmicrotune__4702.html#aa55a60d3d2cf8d8ef30f701fcf8edff2">microtune_4702</a>, and <a class="el" href="classmicrotune__4937.html#a27894b05227f59b707e321a02a51abfc">microtune_4937</a>.</p>
</div>
</div>
<a class="anchor" id="a7cf6ff57a511f70662f02f303dcef0e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double microtune_xxxx::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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="microtune__xxxx_8h_source.html">microtune_xxxx.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classmicrotune__xxxx.html">microtune_xxxx</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:39 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
