Sophie

Sophie

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

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_xxxx_eval_board.h Source File</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('microtune__xxxx__eval__board_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>microtune_xxxx_eval_board.h</h1>  </div>
</div>
<div class="contents">
<a href="microtune__xxxx__eval__board_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- C++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2001,2004 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classmicrotune__xxxx.html" title="abstract class for controlling microtune {4937,4702} tuner modules">microtune_xxxx</a>;
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classppio.html" title="abstract class that provides low level access to parallel port bits">ppio</a>;
<a name="l00031"></a>00031 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr&lt;ppio&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">ppio_sptr</a>;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classi2c.html" title="abstract class for controlling i2c bus">i2c</a>;
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr&lt;i2c&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html">i2c_sptr</a>;
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/*!</span>
<a name="l00037"></a>00037 <span class="comment"> * \brief abstract class for controlling microtune xxxx eval board</span>
<a name="l00038"></a>00038 <span class="comment"> * \ingroup hardware</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a><a class="code" href="classmicrotune__xxxx__eval__board.html">00040</a> <span class="keyword">class </span><a class="code" href="classmicrotune__xxxx__eval__board.html" title="abstract class for controlling microtune xxxx eval board">microtune_xxxx_eval_board</a> {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042   <a class="code" href="classmicrotune__xxxx__eval__board.html#ad0effba516749e66b4bcd2d2da394d22">microtune_xxxx_eval_board</a> (<span class="keywordtype">int</span> which_pp = 0);
<a name="l00043"></a>00043   <span class="keyword">virtual</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#a4f2924691c7683ed5263c53582961283">~microtune_xxxx_eval_board</a> ();
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">  //! is the eval board present?</span>
<a name="l00046"></a>00046 <span class="comment"></span>  <span class="keywordtype">bool</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#a7c33c3a304b3a3837aebe0b939795908" title="is the eval board present?">board_present_p</a> ();
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">  /*!</span>
<a name="l00049"></a>00049 <span class="comment">   * \brief set RF and IF AGC control voltages ([0, 5] volts)</span>
<a name="l00050"></a>00050 <span class="comment">   */</span>
<a name="l00051"></a>00051   <span class="keywordtype">void</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#adb0dc9f8e36e6960d92993f46a6c6909" title="set RF and IF AGC control voltages ([0, 5] volts)">set_RF_AGC_voltage</a> (<span class="keywordtype">float</span> volts);
<a name="l00052"></a>00052   <span class="keywordtype">void</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#aa013afa53992233db6020ee1e973f486">set_IF_AGC_voltage</a> (<span class="keywordtype">float</span> volts);
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">  /*!</span>
<a name="l00055"></a>00055 <span class="comment">   * \brief set RF and IF AGC levels together (scale [0, 1000])</span>
<a name="l00056"></a>00056 <span class="comment">   *</span>
<a name="l00057"></a>00057 <span class="comment">   * This provides a simple linear interface for adjusting both</span>
<a name="l00058"></a>00058 <span class="comment">   * the RF and IF gain in consort.  This is the easy to use interface.</span>
<a name="l00059"></a>00059 <span class="comment">   * 0 corresponds to minimum gain. 1000 corresponds to maximum gain.</span>
<a name="l00060"></a>00060 <span class="comment">   */</span>
<a name="l00061"></a>00061   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#a309de3cd072b0414f2f76498d1536cf0" title="set RF and IF AGC levels together (scale [0, 1000])">set_AGC</a> (<span class="keywordtype">float</span> value_0_1000) = 0;
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment">  /*!</span>
<a name="l00064"></a>00064 <span class="comment">   * \brief select RF frequency to be tuned to output frequency.</span>
<a name="l00065"></a>00065 <span class="comment">   * \p freq is the requested frequency in Hz, \p actual_freq</span>
<a name="l00066"></a>00066 <span class="comment">   * is set to the actual frequency tuned.  It takes about 100 ms</span>
<a name="l00067"></a>00067 <span class="comment">   * for the PLL to settle.</span>
<a name="l00068"></a>00068 <span class="comment">   *</span>
<a name="l00069"></a>00069 <span class="comment">   * \returns true iff sucessful.</span>
<a name="l00070"></a>00070 <span class="comment">   */</span>
<a name="l00071"></a>00071   <span class="keywordtype">bool</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#afc1ab59edaaba910a2351298cc4da462" title="select RF frequency to be tuned to output frequency. freq is the requested frequency in Hz...">set_RF_freq</a> (<span class="keywordtype">double</span> freq, <span class="keywordtype">double</span> *actual_freq);
<a name="l00072"></a>00072   
<a name="l00073"></a>00073   <span class="comment">// returns actual freq or 0 if error (easier interface for SWIG)</span>
<a name="l00074"></a>00074   <span class="keywordtype">double</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#afc1ab59edaaba910a2351298cc4da462" title="select RF frequency to be tuned to output frequency. freq is the requested frequency in Hz...">set_RF_freq</a> (<span class="keywordtype">double</span> freq);
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">  /*!</span>
<a name="l00077"></a>00077 <span class="comment">   * \returns true iff PLL is locked</span>
<a name="l00078"></a>00078 <span class="comment">   */</span>
<a name="l00079"></a>00079   <span class="keywordtype">bool</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#aea5c168dd36594567dac976c6b308e98">pll_locked_p</a> ();
<a name="l00080"></a>00080   <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment">  /*!</span>
<a name="l00082"></a>00082 <span class="comment">   * \returns the output frequency (IF center freq) of the tuner in Hz.</span>
<a name="l00083"></a>00083 <span class="comment">   */</span>
<a name="l00084"></a>00084   <span class="keywordtype">double</span> <a class="code" href="classmicrotune__xxxx__eval__board.html#acb8c57351294269244d6ce6269f230eb">get_output_freq</a> ();
<a name="l00085"></a>00085 
<a name="l00086"></a>00086 
<a name="l00087"></a>00087 <span class="keyword">private</span>:
<a name="l00088"></a>00088   <span class="keywordtype">void</span> write_dac (<span class="keywordtype">int</span> which, <span class="keywordtype">int</span> value);
<a name="l00089"></a>00089   <span class="keywordtype">void</span> write_both_dacs (<span class="keywordtype">int</span> val0, <span class="keywordtype">int</span> val1);
<a name="l00090"></a>00090   
<a name="l00091"></a>00091 <span class="keyword">protected</span>:
<a name="l00092"></a><a class="code" href="classmicrotune__xxxx__eval__board.html#a61be9a0910599fbbdd4b0164b5453843">00092</a>   <a class="code" href="classboost_1_1shared__ptr.html">ppio_sptr</a>             <a class="code" href="classmicrotune__xxxx__eval__board.html#a61be9a0910599fbbdd4b0164b5453843">d_ppio</a>;
<a name="l00093"></a><a class="code" href="classmicrotune__xxxx__eval__board.html#a6fc807ce2050b39fa5bf887a657837ae">00093</a>   <a class="code" href="classboost_1_1shared__ptr.html">i2c_sptr</a>              <a class="code" href="classmicrotune__xxxx__eval__board.html#a6fc807ce2050b39fa5bf887a657837ae">d_i2c</a>;
<a name="l00094"></a><a class="code" href="classmicrotune__xxxx__eval__board.html#a7734fb4f9c1e4843b149628c2c38d3a5">00094</a>   <a class="code" href="classmicrotune__xxxx.html" title="abstract class for controlling microtune {4937,4702} tuner modules">microtune_xxxx</a>       *<a class="code" href="classmicrotune__xxxx__eval__board.html#a7734fb4f9c1e4843b149628c2c38d3a5">d_tuner</a>;
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="microtune__xxxx__eval__board_8h.html">microtune_xxxx_eval_board.h</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>