Sophie

Sophie

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

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: usrp2_source_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('usrp2__source__base_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>usrp2_source_base.h</h1>  </div>
</div>
<div class="contents">
<a href="usrp2__source__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,2009 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_USRP2_SOURCE_BASE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP2_SOURCE_BASE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="usrp2__base_8h.html">usrp2_base.h</a>&gt;</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/*!</span>
<a name="l00029"></a>00029 <span class="comment"> * Base class for all USRP2 source blocks</span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a><a class="code" href="classusrp2__source__base.html">00031</a> <span class="keyword">class </span><a class="code" href="classusrp2__source__base.html">usrp2_source_base</a> : <span class="keyword">public</span> <a class="code" href="classusrp2__base.html">usrp2_base</a> 
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keyword">protected</span>:
<a name="l00034"></a>00034   <a class="code" href="classusrp2__source__base.html#a0422216c52c7f6372f73b1af25ce7be1">usrp2_source_base</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>,
<a name="l00035"></a>00035                     <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>,
<a name="l00036"></a>00036                     <span class="keyword">const</span> std::string &amp;ifc,
<a name="l00037"></a>00037                     <span class="keyword">const</span> std::string &amp;mac)
<a name="l00038"></a>00038     <span class="keywordflow">throw</span> (std::runtime_error);
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041   <a class="code" href="classusrp2__source__base.html#a6411e782f3e317bfa17c02da00828b4b">~usrp2_source_base</a>();
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">  /*!</span>
<a name="l00044"></a>00044 <span class="comment">   * \brief Set receiver gain</span>
<a name="l00045"></a>00045 <span class="comment">   */</span>
<a name="l00046"></a>00046   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a748af984ecaa41a68065d3ebd14521df" title="Set receiver gain.">set_gain</a>(<span class="keywordtype">double</span> gain);
<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 receive LO offset frequency</span>
<a name="l00050"></a>00050 <span class="comment">   */</span>
<a name="l00051"></a>00051   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a86dc5ff501fe0228ce3bd2e9f69557aa" title="Set receive LO offset frequency.">set_lo_offset</a>(<span class="keywordtype">double</span> frequency);
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">  /*!</span>
<a name="l00054"></a>00054 <span class="comment">   * \brief Set receiver center frequency</span>
<a name="l00055"></a>00055 <span class="comment">   */</span>
<a name="l00056"></a>00056   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a2e9bf52183307d74e6e71e2399ef8bc7" title="Set receiver center frequency.">set_center_freq</a>(<span class="keywordtype">double</span> frequency, <a class="code" href="classusrp2_1_1tune__result.html">usrp2::tune_result</a> *tr);
<a name="l00057"></a>00057    <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">  /*!</span>
<a name="l00059"></a>00059 <span class="comment">   * \brief Set receive decimation rate</span>
<a name="l00060"></a>00060 <span class="comment">   */</span>
<a name="l00061"></a>00061   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#ac4a28e658b93ee054a2cff557c240c98" title="Set receive decimation rate.">set_decim</a>(<span class="keywordtype">int</span> decimation_factor);
<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 Set receive IQ scale factors</span>
<a name="l00065"></a>00065 <span class="comment">   */</span>
<a name="l00066"></a>00066   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a5890349072e561082aa7ba378e56ef33" title="Set receive IQ scale factors.">set_scale_iq</a>(<span class="keywordtype">int</span> scale_i, <span class="keywordtype">int</span> scale_q);
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">  /*!</span>
<a name="l00069"></a>00069 <span class="comment">   * \brief Get receive decimation rate</span>
<a name="l00070"></a>00070 <span class="comment">   */</span>
<a name="l00071"></a>00071   <span class="keywordtype">int</span> <a class="code" href="classusrp2__source__base.html#ac3558bdced2eaec9007d282cb5c37c88" title="Get receive decimation rate.">decim</a>();
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">  /*!</span>
<a name="l00074"></a>00074 <span class="comment">   * \brief Get the ADC sample rate</span>
<a name="l00075"></a>00075 <span class="comment">   */</span>
<a name="l00076"></a>00076   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#ae31a1c60fbe8ebc2431136c264fdd958" title="Get the ADC sample rate.">adc_rate</a>(<span class="keywordtype">long</span> *rate);
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">  /*!</span>
<a name="l00079"></a>00079 <span class="comment">   * \brief Returns minimum Rx gain </span>
<a name="l00080"></a>00080 <span class="comment">   */</span>
<a name="l00081"></a>00081   <span class="keywordtype">double</span> <a class="code" href="classusrp2__source__base.html#afcef1b980e3a12d198dd1a7df1012788" title="Returns minimum Rx gain.">gain_min</a>();
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">  /*!</span>
<a name="l00084"></a>00084 <span class="comment">   * \brief Returns maximum Rx gain </span>
<a name="l00085"></a>00085 <span class="comment">   */</span>
<a name="l00086"></a>00086   <span class="keywordtype">double</span> <a class="code" href="classusrp2__source__base.html#a9387449d7e1bbb43716f63d35af9fece" title="Returns maximum Rx gain.">gain_max</a>();
<a name="l00087"></a>00087   <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment">  /*!</span>
<a name="l00089"></a>00089 <span class="comment">   * \brief Returns Rx gain db_per_step</span>
<a name="l00090"></a>00090 <span class="comment">   */</span>
<a name="l00091"></a>00091   <span class="keywordtype">double</span> <a class="code" href="classusrp2__source__base.html#a627e8288cae3358269dba75df0631a63" title="Returns Rx gain db_per_step.">gain_db_per_step</a>();
<a name="l00092"></a>00092   <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">  /*!</span>
<a name="l00094"></a>00094 <span class="comment">   * \brief Returns minimum Rx center frequency</span>
<a name="l00095"></a>00095 <span class="comment">   */</span>
<a name="l00096"></a>00096   <span class="keywordtype">double</span> <a class="code" href="classusrp2__source__base.html#af2a51daad3252aa3865f01ea2131ff32" title="Returns minimum Rx center frequency.">freq_min</a>();
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">  /*!</span>
<a name="l00099"></a>00099 <span class="comment">   * \brief Returns maximum Rx center frequency</span>
<a name="l00100"></a>00100 <span class="comment">   */</span>
<a name="l00101"></a>00101   <span class="keywordtype">double</span> <a class="code" href="classusrp2__source__base.html#a27227ec20b0f085c7870eecbca9ccba6" title="Returns maximum Rx center frequency.">freq_max</a>();
<a name="l00102"></a>00102   <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment">  /*!</span>
<a name="l00104"></a>00104 <span class="comment">   * \brief Get Rx daughterboard ID</span>
<a name="l00105"></a>00105 <span class="comment">   *</span>
<a name="l00106"></a>00106 <span class="comment">   * \param[out] dbid returns the daughterboard id.</span>
<a name="l00107"></a>00107 <span class="comment">   *</span>
<a name="l00108"></a>00108 <span class="comment">   * daughterboard id &gt;= 0 if successful, -1 if no daugherboard installed,</span>
<a name="l00109"></a>00109 <span class="comment">   * -2 if invalid EEPROM on daughterboard.</span>
<a name="l00110"></a>00110 <span class="comment">   */</span>
<a name="l00111"></a>00111   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a69f1e756ba233165978935f7ba3b3765" title="Get Rx daughterboard ID.">daughterboard_id</a>(<span class="keywordtype">int</span> *dbid);
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">  /*!</span>
<a name="l00114"></a>00114 <span class="comment">   * \brief Returns number of receiver overruns</span>
<a name="l00115"></a>00115 <span class="comment">   */</span>
<a name="l00116"></a>00116   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2__source__base.html#a3b6e8049de302c14f72c0ecfa4f9ed3d" title="Returns number of receiver overruns.">overruns</a>();
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment">  /*!</span>
<a name="l00119"></a>00119 <span class="comment">   * \brief Returns number of missing sequence numbers</span>
<a name="l00120"></a>00120 <span class="comment">   */</span>
<a name="l00121"></a>00121   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2__source__base.html#ac831146afc71f8b94179dd824b99bd67" title="Returns number of missing sequence numbers.">missing</a>();
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">  /*!</span>
<a name="l00124"></a>00124 <span class="comment">   * \brief Called by scheduler when starting flowgraph</span>
<a name="l00125"></a>00125 <span class="comment">   */</span>
<a name="l00126"></a>00126   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a8283ff40606ce6fc239a0cf52a67cfa4" title="Called by scheduler when starting flowgraph.">start</a>();
<a name="l00127"></a>00127   <span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment">  /*!</span>
<a name="l00129"></a>00129 <span class="comment">   * \brief Called by scheduler when stopping flowgraph</span>
<a name="l00130"></a>00130 <span class="comment">   */</span>
<a name="l00131"></a>00131   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#adea8505626b80ad87a5ad4092b2a639a" title="Called by scheduler when stopping flowgraph.">stop</a>();
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment">  /*!</span>
<a name="l00134"></a>00134 <span class="comment">   * \brief Set daughterboard GPIO data direction register.</span>
<a name="l00135"></a>00135 <span class="comment">   */</span>
<a name="l00136"></a>00136   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a57c6fd87244cf551615380f509d5823a" title="Set daughterboard GPIO data direction register.">set_gpio_ddr</a>(uint16_t value, uint16_t mask);
<a name="l00137"></a>00137 <span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment">  /*!</span>
<a name="l00139"></a>00139 <span class="comment">   * \brief Set daughterboard GPIO output selection register.</span>
<a name="l00140"></a>00140 <span class="comment">   */</span>
<a name="l00141"></a>00141   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#ac14c8e38a43f3ebb4f9d5e396c1f1131" title="Set daughterboard GPIO output selection register.">set_gpio_sels</a>(std::string sels);
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment">  /*!</span>
<a name="l00144"></a>00144 <span class="comment">   * \brief Set daughterboard GPIO pin values.</span>
<a name="l00145"></a>00145 <span class="comment">   */</span>
<a name="l00146"></a>00146   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a3e28692c1f747a4bde3d73695e53981f" title="Set daughterboard GPIO pin values.">write_gpio</a>(uint16_t value, uint16_t mask);
<a name="l00147"></a>00147 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment">  /*!</span>
<a name="l00149"></a>00149 <span class="comment">   * \brief Read daughterboard GPIO pin values</span>
<a name="l00150"></a>00150 <span class="comment">   */</span>
<a name="l00151"></a>00151   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#af3b7947d9c8b554e66795cc1c2c69dea" title="Read daughterboard GPIO pin values.">read_gpio</a>(uint16_t *value);
<a name="l00152"></a>00152 <span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment">  /*!</span>
<a name="l00154"></a>00154 <span class="comment">   * \brief Enable streaming GPIO in sample LSBs</span>
<a name="l00155"></a>00155 <span class="comment">   */</span>
<a name="l00156"></a>00156   <span class="keywordtype">bool</span> <a class="code" href="classusrp2__source__base.html#a23fa7df8911c783bd95e7ae3d77d0285" title="Enable streaming GPIO in sample LSBs.">enable_gpio_streaming</a>(<span class="keywordtype">int</span> enable);
<a name="l00157"></a>00157 };
<a name="l00158"></a>00158 
<a name="l00159"></a>00159 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP2_SOURCE_BASE_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="usrp2__source__base_8h.html">usrp2_source_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>