Sophie

Sophie

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

gnuradio-doc-3.2.2-9.fc14.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_4937 Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classmicrotune__4937.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>microtune_4937 Class Reference<div class="ingroups"><a class="el" href="group__hardware.html">Misc Hardware Control</a></div></h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="microtune_4937" --><!-- doxytag: inherits="microtune_xxxx" -->
<p>class for controlling microtune 4937 tuner module  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="microtune__4937_8h_source.html">microtune_4937.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for microtune_4937:</div>
<div class="dyncontent">
<div class="center"><img src="classmicrotune__4937__inherit__graph.png" border="0" usemap="#microtune__4937_inherit__map" alt="Inheritance graph"/></div>
<map name="microtune__4937_inherit__map" id="microtune__4937_inherit__map">
<area shape="rect" id="node2" href="classmicrotune__xxxx.html" title="abstract class for controlling microtune {4937,4702} tuner modules" alt="" coords="5,5,120,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classmicrotune__4937-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__4937.html#af1201de41386251b801d60e6f6966b1b">microtune_4937</a> (<a class="el" href="classboost_1_1shared__ptr.html">i2c_sptr</a> <a class="el" href="classi2c.html">i2c</a>, int i2c_addr=0x61)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__4937.html#af09813417fa744a8deaa8b6b117882c1">~microtune_4937</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__4937.html#a27894b05227f59b707e321a02a51abfc">set_RF_freq</a> (double freq, double *actual_freq)</td></tr>
<tr><td class="mdescLeft">&#160;</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="#a27894b05227f59b707e321a02a51abfc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__4937.html#a0f5ec2bcbbf7120900ce12c87d15dc95">pll_locked_p</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmicrotune__4937.html#a02613c15713ccb19805140c1911e4443">get_output_freq</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>class for controlling microtune 4937 tuner module </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af1201de41386251b801d60e6f6966b1b"></a><!-- doxytag: member="microtune_4937::microtune_4937" ref="af1201de41386251b801d60e6f6966b1b" args="(i2c_sptr i2c, int i2c_addr=0x61)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">microtune_4937::microtune_4937 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">i2c_sptr</a>&#160;</td>
          <td class="paramname"><em>i2c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>i2c_addr</em> = <code>0x61</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="af09813417fa744a8deaa8b6b117882c1"></a><!-- doxytag: member="microtune_4937::~microtune_4937" ref="af09813417fa744a8deaa8b6b117882c1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual microtune_4937::~microtune_4937 </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="a02613c15713ccb19805140c1911e4443"></a><!-- doxytag: member="microtune_4937::get_output_freq" ref="a02613c15713ccb19805140c1911e4443" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double microtune_4937::get_output_freq </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [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>Implements <a class="el" href="classmicrotune__xxxx.html#ad2f4da6893763446700314258495d8cc">microtune_xxxx</a>.</p>

</div>
</div>
<a class="anchor" id="a0f5ec2bcbbf7120900ce12c87d15dc95"></a><!-- doxytag: member="microtune_4937::pll_locked_p" ref="a0f5ec2bcbbf7120900ce12c87d15dc95" 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_4937::pll_locked_p </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [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>Implements <a class="el" href="classmicrotune__xxxx.html#a28ce9c429b571c70a7fa41dd07d11b9a">microtune_xxxx</a>.</p>

</div>
</div>
<a class="anchor" id="a27894b05227f59b707e321a02a51abfc"></a><!-- doxytag: member="microtune_4937::set_RF_freq" ref="a27894b05227f59b707e321a02a51abfc" 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_4937::set_RF_freq </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>freq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>actual_freq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [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>Implements <a class="el" href="classmicrotune__xxxx.html#a76ecad84f1f57ce34585056b18ac8d99">microtune_xxxx</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="microtune__4937_8h_source.html">microtune_4937.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classmicrotune__4937.html">microtune_4937</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>