<!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_c 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('classusrp__source__c.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>usrp_source_c Class Reference<div class="ingroups"><a class="el" href="group__usrp.html">USRP</a> | <a class="el" href="group__source__blk.html">Signal Sources</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="usrp_source_c" --><!-- doxytag: inherits="usrp_source_base" -->
<p>Interface to Universal Software Radio Peripheral Rx pathoutput: 1 stream of complex<float>
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="usrp__source__c_8h_source.html">usrp_source_c.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for usrp_source_c:</div>
<div class="dyncontent">
<div class="center"><img src="classusrp__source__c__inherit__graph.png" border="0" usemap="#usrp__source__c_inherit__map" alt="Inheritance graph"/></div>
<map name="usrp__source__c_inherit__map" id="usrp__source__c_inherit__map">
<area shape="rect" id="node2" href="classusrp__source__base.html" title="abstract interface to Universal Software Radio Peripheral Rx path (Rev 1)" alt="" coords="5,315,133,344"/><area shape="rect" id="node4" href="classusrp__base.html" title="base class for GNU Radio interface to the USRP" alt="" coords="28,237,111,267"/><area shape="rect" id="node6" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="16,160,123,189"/><area shape="rect" id="node8" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="35,83,104,112"/><area shape="rect" id="node10" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="15,5,124,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classusrp__source__c-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__source__c.html#ade2b147805f4de19e264bf5bef6cc579">~usrp_source_c</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__source__c.html#acb70800dacb54750f4fe6bb5313375ff">usrp_source_c</a> (int which_board, unsigned int decim_rate, int nchan, int mux, int mode, int fusb_block_size, int fusb_nblocks, const std::string fpga_filename, const std::string firmware_filename) throw (std::runtime_error)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__source__c.html#a88bb494a8b98482289e19d21da0bc48d">ninput_bytes_reqd_for_noutput_items</a> (int noutput_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return number of usrp input bytes required to produce noutput items. <a href="#a88bb494a8b98482289e19d21da0bc48d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__source__c.html#abdca6147417b17d3daf8fc95ebb47b49">copy_from_usrp_buffer</a> (<a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items, int output_index, int output_items_available, int &output_items_produced, const void *usrp_buffer, int usrp_buffer_length, int &bytes_read)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">convert between native usrp format and output item format <a href="#abdca6147417b17d3daf8fc95ebb47b49"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">usrp_source_c_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__source__c.html#a8d833b996c46167b02ebf53ba8b0e6fc">usrp_make_source_c</a> (int which_board, unsigned int decim_rate, int nchan, int mux, int mode, int fusb_block_size, int fusb_nblocks, const std::string fpga_filename, const std::string firmware_filename) throw (std::runtime_error)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface to Universal Software Radio Peripheral Rx path</p>
<p>output: 1 stream of complex<float> </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="acb70800dacb54750f4fe6bb5313375ff"></a><!-- doxytag: member="usrp_source_c::usrp_source_c" ref="acb70800dacb54750f4fe6bb5313375ff" args="(int which_board, unsigned int decim_rate, int nchan, int mux, int mode, int fusb_block_size, int fusb_nblocks, const std::string fpga_filename, const std::string firmware_filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp_source_c::usrp_source_c </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>which_board</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>decim_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nchan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mux</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fusb_block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fusb_nblocks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>fpga_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>firmware_filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw (std::runtime_error)<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ade2b147805f4de19e264bf5bef6cc579"></a><!-- doxytag: member="usrp_source_c::~usrp_source_c" ref="ade2b147805f4de19e264bf5bef6cc579" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp_source_c::~usrp_source_c </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abdca6147417b17d3daf8fc95ebb47b49"></a><!-- doxytag: member="usrp_source_c::copy_from_usrp_buffer" ref="abdca6147417b17d3daf8fc95ebb47b49" args="(gr_vector_void_star &output_items, int output_index, int output_items_available, int &output_items_produced, const void *usrp_buffer, int usrp_buffer_length, int &bytes_read)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void usrp_source_c::copy_from_usrp_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"><em>output_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>output_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>output_items_available</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"><em>output_items_produced</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>usrp_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>usrp_buffer_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"><em>bytes_read</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>convert between native usrp format and output item format </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">output_items</td><td>stream(s) of output items </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">output_index</td><td>starting index in output_items </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">output_items_available</td><td>number of empty items available at item[index] </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">output_items_produced</td><td>number of items produced by copy </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">usrp_buffer</td><td>source buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">usrp_buffer_length</td><td>number of bytes available in <code>usrp_buffer</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">bytes_read</td><td>number of bytes read from <code>usrp_buffer</code> </td></tr>
</table>
</dd>
</dl>
<p>The copy must consume all bytes available. That is, <code>bytes_read</code> must equal <code>usrp_buffer_length</code>. </p>
<p>Implements <a class="el" href="classusrp__source__base.html#a5192b3690b953a7d10b8ba2ab5807450">usrp_source_base</a>.</p>
</div>
</div>
<a class="anchor" id="a88bb494a8b98482289e19d21da0bc48d"></a><!-- doxytag: member="usrp_source_c::ninput_bytes_reqd_for_noutput_items" ref="a88bb494a8b98482289e19d21da0bc48d" args="(int noutput_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int usrp_source_c::ninput_bytes_reqd_for_noutput_items </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>noutput_items</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return number of usrp input bytes required to produce noutput items. </p>
<p>Implements <a class="el" href="classusrp__source__base.html#a90f5535f66ab25e1e512d868270fa653">usrp_source_base</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a8d833b996c46167b02ebf53ba8b0e6fc"></a><!-- doxytag: member="usrp_source_c::usrp_make_source_c" ref="a8d833b996c46167b02ebf53ba8b0e6fc" args="(int which_board, unsigned int decim_rate, int nchan, int mux, int mode, int fusb_block_size, int fusb_nblocks, const std::string fpga_filename, const std::string firmware_filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">usrp_source_c_sptr</a> usrp_make_source_c </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>which_board</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>decim_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nchan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mux</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fusb_block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fusb_nblocks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>fpga_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>firmware_filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw (std::runtime_error)<code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="usrp__source__c_8h_source.html">usrp_source_c.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classusrp__source__c.html">usrp_source_c</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
3039
