<!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_sink_c 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_sink_c Class Reference<br/>
<small>
[<a class="el" href="group__usrp.html">USRP</a>, <a class="el" href="group__sink__blk.html">Signal Sinks</a>]</small>
</h1><!-- doxytag: class="usrp_sink_c" --><!-- doxytag: inherits="usrp_sink_base" -->
<p>Interface to Universal Software Radio Peripheral Tx pathinput: gr_complex.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="usrp__sink__c_8h_source.html">usrp_sink_c.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for usrp_sink_c:</div>
<div class="dynsection">
<div class="center"><img src="classusrp__sink__c__inherit__graph.png" border="0" usemap="#usrp__sink__c_inherit__map" alt="Inheritance graph"/></div>
<map name="usrp__sink__c_inherit__map" id="usrp__sink__c_inherit__map">
<area shape="rect" id="node2" href="classusrp__sink__base.html" title="abstract interface to Universal Software Radio Peripheral Tx path (Rev 1)" alt="" coords="5,315,117,344"/><area shape="rect" id="node4" href="classusrp__base.html" title="base class for GNU Radio interface to the USRP" alt="" coords="20,237,103,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="8,160,115,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="27,83,96,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="7,5,116,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classusrp__sink__c-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__sink__c.html#a7f4eac4d73566a621cb65d9d6b10910b">~usrp_sink_c</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__sink__c.html#a78a2167f55784ee090af29e7298a20cd">usrp_sink_c</a> (int which_board, unsigned int interp_rate, int nchan, int mux, 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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__sink__c.html#ae7c2e29029474bf9bbc7139e52dc3a7d">copy_to_usrp_buffer</a> (<a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, int input_index, int input_items_available, int &input_items_consumed, void *usrp_buffer, int usrp_buffer_length, int &bytes_written)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">convert between input item format and usrp native format <a href="#ae7c2e29029474bf9bbc7139e52dc3a7d"></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_sink_c_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp__sink__c.html#ac54a4bc557defc1c1157d09ef523cb4a">usrp_make_sink_c</a> (int which_board, unsigned int interp_rate, int nchan, int mux, 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 Tx path</p>
<p>input: gr_complex. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a78a2167f55784ee090af29e7298a20cd"></a><!-- doxytag: member="usrp_sink_c::usrp_sink_c" ref="a78a2167f55784ee090af29e7298a20cd" args="(int which_board, unsigned int interp_rate, int nchan, int mux, 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_sink_c::usrp_sink_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>interp_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>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="a7f4eac4d73566a621cb65d9d6b10910b"></a><!-- doxytag: member="usrp_sink_c::~usrp_sink_c" ref="a7f4eac4d73566a621cb65d9d6b10910b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp_sink_c::~usrp_sink_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="ae7c2e29029474bf9bbc7139e52dc3a7d"></a><!-- doxytag: member="usrp_sink_c::copy_to_usrp_buffer" ref="ae7c2e29029474bf9bbc7139e52dc3a7d" args="(gr_vector_const_void_star &input_items, int input_index, int input_items_available, int &input_items_consumed, void *usrp_buffer, int usrp_buffer_length, int &bytes_written)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void usrp_sink_c::copy_to_usrp_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>input_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>input_items_available</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>input_items_consumed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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_written</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 input item format and usrp native format </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>input_items</em> </td><td>stream(s) of input items </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>input_index</em> </td><td>starting index in input_items </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>input_items_available</em> </td><td>number of items available starting at item[index] </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>input_items_consumed</em> </td><td>number of input items consumed by copy </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>usrp_buffer</em> </td><td>destination buffer </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>usrp_buffer_length</em> </td><td><code>usrp_buffer</code> length in bytes </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>bytes_written</em> </td><td>number of bytes written into <code>usrp_buffer</code> </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classusrp__sink__base.html#a028395de3df16fc8b40324ef4333787a">usrp_sink_base</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ac54a4bc557defc1c1157d09ef523cb4a"></a><!-- doxytag: member="usrp_sink_c::usrp_make_sink_c" ref="ac54a4bc557defc1c1157d09ef523cb4a" args="(int which_board, unsigned int interp_rate, int nchan, int mux, 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_sink_c_sptr</a> usrp_make_sink_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>interp_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>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__sink__c_8h_source.html">usrp_sink_c.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>
