<!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 Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <div class="contents"> <h1>usrp_source_s Class Reference<br/> <small> [<a class="el" href="group__usrp.html">USRP</a>, <a class="el" href="group__source__blk.html">Signal Sources</a>]</small> </h1><!-- doxytag: class="usrp_source_s" --><!-- doxytag: inherits="usrp_source_base" --> <p>Interface to Universal Software Radio Peripheral Rx pathoutput: 1 stream of short. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="usrp__source__s_8h_source.html">usrp_source_s.h</a>></code></p> <div class="dynheader"> Inheritance diagram for usrp_source_s:</div> <div class="dynsection"> <div class="center"><img src="classusrp__source__s__inherit__graph.png" border="0" usemap="#usrp__source__s_inherit__map" alt="Inheritance graph"/></div> <map name="usrp__source__s_inherit__map" id="usrp__source__s_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..." 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..." 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..." 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__s-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>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__s.html#a3193d4c6bb978abd38ae8f66db42c1db">~usrp_source_s</a> ()</td></tr> <tr><td colspan="2"><h2>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__s.html#ad91218b788f74749de2506dd7327bfc4">usrp_source_s</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__s.html#ae5ab00e1916365854420482b1185f9ae">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="#ae5ab00e1916365854420482b1185f9ae"></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__s.html#abd953f35fb0a5df060400647041a328a">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="#abd953f35fb0a5df060400647041a328a"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">usrp_source_s_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__source__s.html#a22aa7218f9706c5b730a90174923e042">usrp_make_source_s</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> <p>Interface to Universal Software Radio Peripheral Rx path</p> <p>output: 1 stream of short. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ad91218b788f74749de2506dd7327bfc4"></a><!-- doxytag: member="usrp_source_s::usrp_source_s" ref="ad91218b788f74749de2506dd7327bfc4" 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_s::usrp_source_s </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><td> </td> </tr> <tr> <td></td> <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="a3193d4c6bb978abd38ae8f66db42c1db"></a><!-- doxytag: member="usrp_source_s::~usrp_source_s" ref="a3193d4c6bb978abd38ae8f66db42c1db" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">usrp_source_s::~usrp_source_s </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="abd953f35fb0a5df060400647041a328a"></a><!-- doxytag: member="usrp_source_s::copy_from_usrp_buffer" ref="abd953f35fb0a5df060400647041a328a" 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_s::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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>output_items</em> </td><td>stream(s) of output items </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>output_index</em> </td><td>starting index in output_items </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>output_items_available</em> </td><td>number of empty items available at item[index] </td></tr> <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>output_items_produced</em> </td><td>number of items produced by copy </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>usrp_buffer</em> </td><td>source buffer </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>usrp_buffer_length</em> </td><td>number of bytes available in <code>usrp_buffer</code> </td></tr> <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>bytes_read</em> </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="ae5ab00e1916365854420482b1185f9ae"></a><!-- doxytag: member="usrp_source_s::ninput_bytes_reqd_for_noutput_items" ref="ae5ab00e1916365854420482b1185f9ae" args="(int noutput_items)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int usrp_source_s::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="a22aa7218f9706c5b730a90174923e042"></a><!-- doxytag: member="usrp_source_s::usrp_make_source_s" ref="a22aa7218f9706c5b730a90174923e042" 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_s_sptr</a> usrp_make_source_s </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><td> </td> </tr> <tr> <td></td> <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__s_8h_source.html">usrp_source_s.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>