Sophie

Sophie

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

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: usrp_source_s.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('usrp__source__s_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>usrp_source_s.h</h1>  </div>
</div>
<div class="contents">
<a href="usrp__source__s_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 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_USRP_SOURCE_S_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP_SOURCE_S_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="usrp__source__base_8h.html">usrp_source_base.h</a>&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;stdexcept&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classusrp__standard__rx.html" title="The C++ interface the receive side of the USRPThis is the recommended interface to USRP receive funct...">usrp_standard_rx</a>;
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classusrp__source__s.html" title="Interface to Universal Software Radio Peripheral Rx pathoutput: 1 stream of short.">usrp_source_s</a>;
<a name="l00033"></a>00033 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr&lt;usrp_source_s&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">usrp_source_s_sptr</a>;
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="comment">// public shared_ptr constructor</span>
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">usrp_source_s_sptr</a>
<a name="l00039"></a>00039 <a class="code" href="usrp__source__s_8h.html#a519bb13dc5821759abaab1d0ad94b520">usrp_make_source_s</a> (<span class="keywordtype">int</span> which_board=0, 
<a name="l00040"></a>00040                     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp__source__base.html#a441058246c1ad083fe711c932e6f1762">decim_rate</a>=16,
<a name="l00041"></a>00041                     <span class="keywordtype">int</span> nchan=1,
<a name="l00042"></a>00042                     <span class="keywordtype">int</span> <a class="code" href="classusrp__source__base.html#ac7362b99ce0a8f02b11a09a963b2ec89">mux</a>=-1,
<a name="l00043"></a>00043                     <span class="keywordtype">int</span> mode=0,
<a name="l00044"></a>00044                     <span class="keywordtype">int</span> fusb_block_size=0,
<a name="l00045"></a>00045                     <span class="keywordtype">int</span> fusb_nblocks=0,
<a name="l00046"></a>00046                     <span class="keyword">const</span> std::string fpga_filename=<span class="stringliteral">&quot;&quot;</span>,
<a name="l00047"></a>00047                     <span class="keyword">const</span> std::string firmware_filename=<span class="stringliteral">&quot;&quot;</span>
<a name="l00048"></a>00048                     ) throw (std::runtime_error);
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">/*!</span>
<a name="l00051"></a>00051 <span class="comment"> * \brief Interface to Universal Software Radio Peripheral Rx path</span>
<a name="l00052"></a>00052 <span class="comment"> * \ingroup usrp</span>
<a name="l00053"></a>00053 <span class="comment"> * \ingroup source_blk</span>
<a name="l00054"></a>00054 <span class="comment"> *</span>
<a name="l00055"></a>00055 <span class="comment"> * output: 1 stream of short</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a><a class="code" href="classusrp__source__s.html">00057</a> class <a class="code" href="classusrp__source__s.html" title="Interface to Universal Software Radio Peripheral Rx pathoutput: 1 stream of short.">usrp_source_s</a> : public <a class="code" href="classusrp__source__base.html" title="abstract interface to Universal Software Radio Peripheral Rx path (Rev 1)">usrp_source_base</a> {
<a name="l00058"></a>00058  <span class="keyword">private</span>:
<a name="l00059"></a>00059   <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">usrp_source_s_sptr</a>
<a name="l00060"></a>00060   <a class="code" href="usrp__source__s_8h.html#a519bb13dc5821759abaab1d0ad94b520">usrp_make_source_s</a> (<span class="keywordtype">int</span> which_board, 
<a name="l00061"></a>00061                        <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classusrp__source__base.html#a441058246c1ad083fe711c932e6f1762">decim_rate</a>,
<a name="l00062"></a>00062                        <span class="keywordtype">int</span> nchan,
<a name="l00063"></a>00063                        <span class="keywordtype">int</span> <a class="code" href="classusrp__source__base.html#ac7362b99ce0a8f02b11a09a963b2ec89">mux</a>,
<a name="l00064"></a>00064                        <span class="keywordtype">int</span> mode,
<a name="l00065"></a>00065                        <span class="keywordtype">int</span> fusb_block_size,
<a name="l00066"></a>00066                        <span class="keywordtype">int</span> fusb_nblocks,
<a name="l00067"></a>00067                        <span class="keyword">const</span> std::string fpga_filename,
<a name="l00068"></a>00068                        <span class="keyword">const</span> std::string firmware_filename
<a name="l00069"></a>00069                        ) <span class="keywordflow">throw</span> (std::runtime_error);
<a name="l00070"></a>00070 
<a name="l00071"></a>00071  <span class="keyword">protected</span>:
<a name="l00072"></a>00072   <a class="code" href="classusrp__source__s.html#ad91218b788f74749de2506dd7327bfc4">usrp_source_s</a> (<span class="keywordtype">int</span> which_board, 
<a name="l00073"></a>00073                   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> decim_rate,
<a name="l00074"></a>00074                   <span class="keywordtype">int</span> nchan,
<a name="l00075"></a>00075                   <span class="keywordtype">int</span> mux,
<a name="l00076"></a>00076                   <span class="keywordtype">int</span> mode,
<a name="l00077"></a>00077                   <span class="keywordtype">int</span> fusb_block_size,
<a name="l00078"></a>00078                   <span class="keywordtype">int</span> fusb_nblocks,
<a name="l00079"></a>00079                   <span class="keyword">const</span> std::string fpga_filename,
<a name="l00080"></a>00080                   <span class="keyword">const</span> std::string firmware_filename
<a name="l00081"></a>00081                   ) <span class="keywordflow">throw</span> (std::runtime_error);
<a name="l00082"></a>00082 
<a name="l00083"></a>00083   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classusrp__source__s.html#ae5ab00e1916365854420482b1185f9ae" title="return number of usrp input bytes required to produce noutput items.">ninput_bytes_reqd_for_noutput_items</a> (<span class="keywordtype">int</span> noutput_items);
<a name="l00084"></a>00084 
<a name="l00085"></a>00085   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classusrp__source__s.html#abd953f35fb0a5df060400647041a328a" title="convert between native usrp format and output item format">copy_from_usrp_buffer</a> (<a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items,
<a name="l00086"></a>00086                                       <span class="keywordtype">int</span> output_index,
<a name="l00087"></a>00087                                       <span class="keywordtype">int</span> output_items_available,
<a name="l00088"></a>00088                                       <span class="keywordtype">int</span> &amp;output_items_produced,
<a name="l00089"></a>00089                                       <span class="keyword">const</span> <span class="keywordtype">void</span> *usrp_buffer,
<a name="l00090"></a>00090                                       <span class="keywordtype">int</span> usrp_buffer_length,
<a name="l00091"></a>00091                                       <span class="keywordtype">int</span> &amp;bytes_read);
<a name="l00092"></a>00092  <span class="keyword">public</span>:
<a name="l00093"></a>00093   <a class="code" href="classusrp__source__s.html#a3193d4c6bb978abd38ae8f66db42c1db">~usrp_source_s</a> ();
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP_SOURCE_S_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="usrp__source__s_8h.html">usrp_source_s.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>