Sophie

Sophie

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

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: db_base.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('db__base_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>db_base.h</h1>  </div>
</div>
<div class="contents">
<a href="db__base_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 2008 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 asversion 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_DB_BASE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_DB_BASE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/weak_ptr.hpp&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;iosfwd&gt;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classdb__base.html" title="Abstract base class for all USRP daughterboards.">db_base</a>;
<a name="l00032"></a>00032 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr&lt;db_base&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">db_base_sptr</a>;
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classusrp__basic.html" title="abstract base class for usrp operations">usrp_basic</a>;
<a name="l00035"></a>00035 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr&lt;usrp_basic&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html">usrp_basic_sptr</a>;
<a name="l00036"></a>00036 
<a name="l00037"></a><a class="code" href="structfreq__result__t.html">00037</a> <span class="keyword">struct </span><a class="code" href="structfreq__result__t.html">freq_result_t</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a><a class="code" href="structfreq__result__t.html#a05f1d913c001ce385efb798e8ec9b649">00039</a>   <span class="keywordtype">bool</span>  <a class="code" href="structfreq__result__t.html#a05f1d913c001ce385efb798e8ec9b649">ok</a>;
<a name="l00040"></a><a class="code" href="structfreq__result__t.html#a1c7c958029dfd98e62b6e1fa60fb5a1f">00040</a>   <span class="keywordtype">double</span> <a class="code" href="structfreq__result__t.html#a1c7c958029dfd98e62b6e1fa60fb5a1f">baseband_freq</a>;
<a name="l00041"></a>00041 };
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <span class="comment">/******************************************************************************/</span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/*!</span>
<a name="l00046"></a>00046 <span class="comment"> * \brief Abstract base class for all USRP daughterboards</span>
<a name="l00047"></a>00047 <span class="comment"> * \ingroup usrp</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a><a class="code" href="classdb__base.html">00049</a> <span class="keyword">class </span><a class="code" href="classdb__base.html" title="Abstract base class for all USRP daughterboards.">db_base</a>
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051  <span class="keyword">protected</span>:
<a name="l00052"></a><a class="code" href="classdb__base.html#ac181e0dee5a23fcd36e1e610965ae1b9">00052</a>   <span class="keywordtype">bool</span>                          <a class="code" href="classdb__base.html#ac181e0dee5a23fcd36e1e610965ae1b9">d_is_shutdown</a>;
<a name="l00053"></a><a class="code" href="classdb__base.html#aa6e5420338ff3e0a9b1afe2ae1fbc58b">00053</a>   <a class="code" href="classusrp__basic.html" title="abstract base class for usrp operations">usrp_basic</a>                   *<a class="code" href="classdb__base.html#aa6e5420338ff3e0a9b1afe2ae1fbc58b">d_raw_usrp</a>;
<a name="l00054"></a><a class="code" href="classdb__base.html#a0d3eb10d9abb8b863dcee0fcb8183d7a">00054</a>   <span class="keywordtype">int</span>                           <a class="code" href="classdb__base.html#a0d3eb10d9abb8b863dcee0fcb8183d7a">d_which</a>;
<a name="l00055"></a><a class="code" href="classdb__base.html#a0665a615c2eb4236814825c89dd024e0">00055</a>   <span class="keywordtype">double</span>                        <a class="code" href="classdb__base.html#a0665a615c2eb4236814825c89dd024e0">d_lo_offset</a>;
<a name="l00056"></a>00056 
<a name="l00057"></a>00057   <span class="keywordtype">void</span> <a class="code" href="classdb__base.html#a7a076785965c3252a663b762b4a25d73">_enable_refclk</a>(<span class="keywordtype">bool</span> enable);
<a name="l00058"></a>00058   <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classdb__base.html#af487af38d9fb82b97082f3e4e34a5f70">_refclk_freq</a>();
<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classdb__base.html#a1617186fd0a8e5dcef601bf1da6eb9f7">_refclk_divisor</a>();
<a name="l00060"></a>00060 
<a name="l00061"></a><a class="code" href="classdb__base.html#a67eafbae0359d2f082f73914d40abc82">00061</a>   <a class="code" href="classusrp__basic.html" title="abstract base class for usrp operations">usrp_basic</a> *<a class="code" href="classdb__base.html#a67eafbae0359d2f082f73914d40abc82">usrp</a>(){
<a name="l00062"></a>00062     <span class="keywordflow">return</span> <a class="code" href="classdb__base.html#aa6e5420338ff3e0a9b1afe2ae1fbc58b">d_raw_usrp</a>;
<a name="l00063"></a>00063   }
<a name="l00064"></a>00064 
<a name="l00065"></a>00065  <span class="keyword">public</span>:
<a name="l00066"></a>00066   <a class="code" href="classdb__base.html#aeddb69ef4218642cb8b03eff94ff8efc">db_base</a>(<a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr&lt;usrp_basic&gt;</a> <a class="code" href="classdb__base.html#a67eafbae0359d2f082f73914d40abc82">usrp</a>, <span class="keywordtype">int</span> <a class="code" href="classdb__base.html#a75f954b2fa50c9309021da9d16a81ee2">which</a>);
<a name="l00067"></a>00067   <span class="keyword">virtual</span> <a class="code" href="classdb__base.html#a87a2c2d64f69b169dd1ef3d4bc60ae82">~db_base</a>();
<a name="l00068"></a>00068 
<a name="l00069"></a>00069   <span class="keywordtype">int</span> <a class="code" href="classdb__base.html#a6c70380b8abff2d051eece9d2b208408">dbid</a>();
<a name="l00070"></a>00070   std::string <a class="code" href="classdb__base.html#aef52f371112795b933570a269da85847">name</a>();
<a name="l00071"></a>00071   std::string <a class="code" href="classdb__base.html#a9cee7496d9a4d09b72a008fb5d7e6664">side_and_name</a>();
<a name="l00072"></a><a class="code" href="classdb__base.html#a75f954b2fa50c9309021da9d16a81ee2">00072</a>   <span class="keywordtype">int</span> <a class="code" href="classdb__base.html#a75f954b2fa50c9309021da9d16a81ee2">which</a>() { <span class="keywordflow">return</span> <a class="code" href="classdb__base.html#a0d3eb10d9abb8b863dcee0fcb8183d7a">d_which</a>; }
<a name="l00073"></a>00073 
<a name="l00074"></a>00074   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a159a4f97c1c6ecc966b6822174e58735">bypass_adc_buffers</a>(<span class="keywordtype">bool</span> bypass);
<a name="l00075"></a>00075   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a13d2573892b4acea9fc0f6125aaee4f2">set_atr_mask</a>(<span class="keywordtype">int</span> v);
<a name="l00076"></a>00076   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a9722d03f078d1206539ad097c28a9562">set_atr_txval</a>(<span class="keywordtype">int</span> v);
<a name="l00077"></a>00077   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aa74f9ee4316672004876d1f2c81728ce">set_atr_rxval</a>(<span class="keywordtype">int</span> v);
<a name="l00078"></a>00078   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a01586c74a2cab95c3e12951402fab1a3">set_atr_tx_delay</a>(<span class="keywordtype">int</span> v);
<a name="l00079"></a>00079   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aec8010d1f2412ffe33bb0f27ee6d8275">set_atr_rx_delay</a>(<span class="keywordtype">int</span> v);
<a name="l00080"></a>00080   <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a3d8eb19a95b9ca4970c56f1a699e85bf">set_lo_offset</a>(<span class="keywordtype">double</span> offset);
<a name="l00081"></a><a class="code" href="classdb__base.html#a07337ac0b59b2d36ced8f0dd7dd58b1e">00081</a>   <span class="keywordtype">double</span> <a class="code" href="classdb__base.html#a07337ac0b59b2d36ced8f0dd7dd58b1e">lo_offset</a>() { <span class="keywordflow">return</span> <a class="code" href="classdb__base.html#a0665a615c2eb4236814825c89dd024e0">d_lo_offset</a>; }
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">  ////////////////////////////////////////////////////////</span>
<a name="l00085"></a>00085 <span class="comment"></span>  <span class="comment">// derived classes should override the following methods</span>
<a name="l00086"></a>00086 
<a name="l00087"></a>00087 <span class="keyword">protected</span>:
<a name="l00088"></a><a class="code" href="classdb__base.html#ad2a0b81e42e8e574d306cd0f24a13717">00088</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classusrp__basic.html" title="abstract base class for usrp operations">usrp_basic</a>;
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">  /*!</span>
<a name="l00091"></a>00091 <span class="comment">   * Called to shutdown daughterboard.  Called from dtor and usrp_basic dtor.</span>
<a name="l00092"></a>00092 <span class="comment">   *</span>
<a name="l00093"></a>00093 <span class="comment">   * N.B., any class that overrides shutdown MUST call shutdown in its destructor.</span>
<a name="l00094"></a>00094 <span class="comment">   */</span>
<a name="l00095"></a>00095   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdb__base.html#abb13a2f1dc7118d9f19337c33722ca3d">shutdown</a>();
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 
<a name="l00098"></a>00098 <span class="keyword">public</span>:
<a name="l00099"></a>00099   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classdb__base.html#a8879fd876f4b31cd78f4713c64140176">gain_min</a>() = 0;
<a name="l00100"></a>00100   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classdb__base.html#aff5b963b288947ba6bfb5d5a6275a074">gain_max</a>() = 0;
<a name="l00101"></a>00101   <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classdb__base.html#adcb54348e840f7c91cfeaa113974d32f">gain_db_per_step</a>() = 0;
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classdb__base.html#a87f1e9f6ebe56002c0d3cd894f91732a">freq_min</a>() = 0;
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="classdb__base.html#afdd3d7d4dc53311b09ce96e06722be08">freq_max</a>() = 0;
<a name="l00104"></a>00104   <span class="keyword">virtual</span> <span class="keyword">struct </span><a class="code" href="structfreq__result__t.html">freq_result_t</a> <a class="code" href="classdb__base.html#a6b23423681d9df85338f5519eed33159">set_freq</a>(double target_freq) = 0;
<a name="l00105"></a>00105   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aa3b2f58f8d96e0b6c4652495338ce2da">set_gain</a>(<span class="keywordtype">float</span> gain) = 0;
<a name="l00106"></a>00106   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a7c6fac86794800bd49b433cbb0ff3b3b">is_quadrature</a>() = 0;
<a name="l00107"></a>00107   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aab2b9d1838530ce5553f0f9af3b965ba">i_and_q_swapped</a>();
<a name="l00108"></a>00108   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a11ea974d07df3f2c411bdf40f9f6d25c">spectrum_inverted</a>();
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aa92e2e87d2bf41457cb6f487c69e1d1f">set_enable</a>(<span class="keywordtype">bool</span> on);
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#a4cc3c2b19392004ecc54c363d541bce8">set_auto_tr</a>(<span class="keywordtype">bool</span> on);
<a name="l00111"></a>00111   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aac3799137016b59b3b57b8d9f422bcbe">select_rx_antenna</a>(<span class="keywordtype">int</span> which_antenna);
<a name="l00112"></a>00112   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#aac3799137016b59b3b57b8d9f422bcbe">select_rx_antenna</a>(<span class="keyword">const</span> std::string &amp;which_antenna);
<a name="l00113"></a>00113   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdb__base.html#ae2905050f95036c2a786180baa308470">set_bw</a>(<span class="keywordtype">float</span> bw);
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 std::ostream &amp; <a class="code" href="gr__basic__block_8h.html#acb2f610728a7f3cbd51a9a2eb60f059e">operator&lt;&lt;</a>(std::ostream &amp;os, <a class="code" href="classdb__base.html" title="Abstract base class for all USRP daughterboards.">db_base</a> &amp;x);
<a name="l00118"></a>00118 
<a name="l00119"></a>00119 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_DB_BASE_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="db__base_8h.html">db_base.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>