Sophie

Sophie

distrib > Fedora > 13 > x86_64 > by-pkgid > ae19f57cd4e306abd5716199a310070b > files > 2541

gnuradio-doc-3.2.2-3.fc13.x86_64.rpm

<!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 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 Class Reference</h1><!-- doxytag: class="microtune_xxxx" -->
<p>abstract class for controlling microtune {4937,4702} tuner modules  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="microtune__xxxx_8h_source.html">microtune_xxxx.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for microtune_xxxx:</div>
<div class="dynsection">
<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,83,120,112"/><area shape="rect" id="node5" href="classmicrotune__4937.html" title="class for controlling microtune 4937 tuner module" alt="" coords="144,83,259,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classmicrotune__xxxx-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a0b1644c14ab5ad28eeb29301cceb68ff">microtune_xxxx</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#af1dd4385969182a435cc3f0d254503df">~microtune_xxxx</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&nbsp;</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><td class="mdescLeft">&nbsp;</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><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a7cf6ff57a511f70662f02f303dcef0e1">set_RF_freq</a> (double freq)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#a28ce9c429b571c70a7fa41dd07d11b9a">pll_locked_p</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__xxxx.html#ad2f4da6893763446700314258495d8cc">get_output_freq</a> ()=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>abstract class for controlling microtune {4937,4702} tuner modules </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0b1644c14ab5ad28eeb29301cceb68ff"></a><!-- doxytag: member="microtune_xxxx::microtune_xxxx" ref="a0b1644c14ab5ad28eeb29301cceb68ff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">microtune_xxxx::microtune_xxxx </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="af1dd4385969182a435cc3f0d254503df"></a><!-- doxytag: member="microtune_xxxx::~microtune_xxxx" ref="af1dd4385969182a435cc3f0d254503df" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual microtune_xxxx::~microtune_xxxx </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad2f4da6893763446700314258495d8cc"></a><!-- doxytag: member="microtune_xxxx::get_output_freq" ref="ad2f4da6893763446700314258495d8cc" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual double microtune_xxxx::get_output_freq </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></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>

<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><!-- doxytag: member="microtune_xxxx::pll_locked_p" ref="a28ce9c429b571c70a7fa41dd07d11b9a" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> microtune_xxxx::pll_locked_p </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></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="a7cf6ff57a511f70662f02f303dcef0e1"></a><!-- doxytag: member="microtune_xxxx::set_RF_freq" ref="a7cf6ff57a511f70662f02f303dcef0e1" args="(double freq)" -->
<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&nbsp;</td>
          <td class="paramname"> <em>freq</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a76ecad84f1f57ce34585056b18ac8d99"></a><!-- doxytag: member="microtune_xxxx::set_RF_freq" ref="a76ecad84f1f57ce34585056b18ac8d99" args="(double freq, double *actual_freq)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> microtune_xxxx::set_RF_freq </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>freq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&nbsp;</td>
          <td class="paramname"> <em>actual_freq</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></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>

<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>
<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>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>