<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_uhd_usrp_sink.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('gr__uhd__usrp__sink_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">gr_uhd_usrp_sink.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="gr__uhd__api_8h_source.html">gr_uhd_api.h</a>></code><br/>
<code>#include <<a class="el" href="gr__sync__block_8h_source.html">gr_sync_block.h</a>></code><br/>
<code>#include <uhd/usrp/multi_usrp.hpp></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for gr_uhd_usrp_sink.h:</div>
<div class="dyncontent">
<div class="center"><img src="gr__uhd__usrp__sink_8h__incl.png" border="0" usemap="#gr__uhd__usrp__sink_8h" alt=""/></div>
<map name="gr__uhd__usrp__sink_8h" id="gr__uhd__usrp__sink_8h">
<area shape="rect" id="node3" href="gr__uhd__api_8h.html" title="gr_uhd_api.h" alt="" coords="1536,80,1632,107"/><area shape="rect" id="node7" href="gr__sync__block_8h.html" title="gr_sync_block.h" alt="" coords="1656,80,1772,107"/><area shape="rect" id="node9" href="gr__core__api_8h.html" title="gr_core_api.h" alt="" coords="1542,560,1641,587"/><area shape="rect" id="node13" href="gr__block_8h.html" title="gr_block.h" alt="" coords="1667,155,1748,181"/><area shape="rect" id="node11" href="attributes_8h.html" title="gruel/attributes.h" alt="" coords="1371,635,1489,661"/><area shape="rect" id="node16" href="gr__basic__block_8h.html" title="gr_basic_block.h" alt="" coords="1319,229,1439,256"/><area shape="rect" id="node103" href="gr__tags_8h.html" title="gr_tags.h" alt="" coords="769,403,844,429"/><area shape="rect" id="node19" href="gr__runtime__types_8h.html" title="gr_runtime_types.h" alt="" coords="1617,403,1751,429"/><area shape="rect" id="node35" href="gr__sptr__magic_8h_source.html" title="gr_sptr_magic.h" alt="" coords="969,485,1084,512"/><area shape="rect" id="node43" href="gr__msg__accepter_8h.html" title="gr_msg_accepter.h" alt="" coords="595,312,728,339"/><area shape="rect" id="node82" href="gr__io__signature_8h.html" title="gr_io_signature.h" alt="" coords="1505,312,1625,339"/><area shape="rect" id="node86" href="thread_8h.html" title="gruel/thread.h" alt="" coords="1328,312,1429,339"/><area shape="rect" id="node22" href="gr__types_8h.html" title="gr_types.h" alt="" coords="1159,485,1240,512"/><area shape="rect" id="node31" href="gr__complex_8h.html" title="gr_complex.h" alt="" coords="1226,560,1325,587"/><area shape="rect" id="node46" href="msg__accepter_8h.html" title="gruel/msg_accepter.h" alt="" coords="597,403,744,429"/><area shape="rect" id="node51" href="pmt_8h.html" title="gruel/pmt.h" alt="" coords="587,485,673,512"/><area shape="rect" id="node48" href="gruel_2src_2include_2gruel_2api_8h.html" title="gruel/api.h" alt="" coords="869,560,951,587"/><area shape="rect" id="node62" href="stdint_8h.html" title="stdint.h" alt="" coords="391,560,456,587"/><area shape="rect" id="node73" href="pmt__sugar_8h.html" title="gruel/pmt_sugar.h" alt="" coords="667,560,793,587"/></map>
</div>
</div>
<p><a href="gr__uhd__usrp__sink_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1stream__args__t.html">uhd::stream_args_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd__usrp__sink.html">uhd_usrp_sink</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceuhd"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceuhd.html">uhd</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7f8bfc83ec7e75ae71bfc3f95aec6dda"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gr__uhd__usrp__sink_8h.html#a7f8bfc83ec7e75ae71bfc3f95aec6dda">INCLUDED_UHD_STREAM_HPP</a></td></tr>
<tr class="separator:a7f8bfc83ec7e75ae71bfc3f95aec6dda"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae6b24e6bb291ec3aeddd50b7c48721b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__uhd__api_8h.html#af9aa018424cf030907c7f8c5a48f4771">GR_UHD_API</a> <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><br class="typebreak"/>
< <a class="el" href="classuhd__usrp__sink.html">uhd_usrp_sink</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__uhd__blk.html#gae6b24e6bb291ec3aeddd50b7c48721b0">uhd_make_usrp_sink</a> (const uhd::device_addr_t &device_addr, const uhd::io_type_t &io_type, size_t num_channels)</td></tr>
<tr class="memdesc:gae6b24e6bb291ec3aeddd50b7c48721b0"><td class="mdescLeft"> </td><td class="mdescRight">Make a new USRP sink block.The USRP sink block reads a stream and transmits the samples. The sink block also provides API calls for transmitter settings. <a href="group__uhd__blk.html#gae6b24e6bb291ec3aeddd50b7c48721b0"></a><br/></td></tr>
<tr class="separator:gae6b24e6bb291ec3aeddd50b7c48721b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36272ab409789053aed7b1a059c61e87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__uhd__api_8h.html#af9aa018424cf030907c7f8c5a48f4771">GR_UHD_API</a> <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><br class="typebreak"/>
< <a class="el" href="classuhd__usrp__sink.html">uhd_usrp_sink</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="gr__uhd__usrp__sink_8h.html#a36272ab409789053aed7b1a059c61e87">uhd_make_usrp_sink</a> (const uhd::device_addr_t &device_addr, const <a class="el" href="structuhd_1_1stream__args__t.html">uhd::stream_args_t</a> &stream_args)</td></tr>
<tr class="memdesc:a36272ab409789053aed7b1a059c61e87"><td class="mdescLeft"> </td><td class="mdescRight">Make a new USRP sink block. <a href="#a36272ab409789053aed7b1a059c61e87"></a><br/></td></tr>
<tr class="separator:a36272ab409789053aed7b1a059c61e87"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a7f8bfc83ec7e75ae71bfc3f95aec6dda"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INCLUDED_UHD_STREAM_HPP</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a36272ab409789053aed7b1a059c61e87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__uhd__api_8h.html#af9aa018424cf030907c7f8c5a48f4771">GR_UHD_API</a> <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><<a class="el" href="classuhd__usrp__sink.html">uhd_usrp_sink</a>> uhd_make_usrp_sink </td>
<td>(</td>
<td class="paramtype">const uhd::device_addr_t & </td>
<td class="paramname"><em>device_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structuhd_1_1stream__args__t.html">uhd::stream_args_t</a> & </td>
<td class="paramname"><em>stream_args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a new USRP sink block. </p>
<p>The USRP sink block reads a stream and transmits the samples. The sink block also provides API calls for transmitter settings.</p>
<p>TX Stream tagging:</p>
<p>The following tag keys will be consumed by the work function:</p>
<ul>
<li><a class="el" href="namespacepmt.html#a9175b04fc88cb7be663ee7b7925dfda6" title="Return the symbol whose name is s.">pmt::pmt_string_to_symbol</a>("tx_sob")</li>
<li><a class="el" href="namespacepmt.html#a9175b04fc88cb7be663ee7b7925dfda6" title="Return the symbol whose name is s.">pmt::pmt_string_to_symbol</a>("tx_eob")</li>
<li><a class="el" href="namespacepmt.html#a9175b04fc88cb7be663ee7b7925dfda6" title="Return the symbol whose name is s.">pmt::pmt_string_to_symbol</a>("tx_time")</li>
</ul>
<p>The sob and eob (start and end of burst) tag values are pmt booleans. When present, burst tags should be set to true (<a class="el" href="namespacepmt.html#ad41a6c124e405727b4b5ea54247005ac">pmt::PMT_T</a>).</p>
<p>The timstamp tag value is a pmt tuple of the following: (uint64 seconds, and double fractional seconds).</p>
<p>See the UHD manual for more detailed documentation: <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki">http://code.ettus.com/redmine/ettus/projects/uhd/wiki</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device_addr</td><td>the address to identify the hardware </td></tr>
<tr><td class="paramname">stream_args</td><td>the IO format and channel specification </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new USRP sink block object </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_ce93430143e8ac85a1502e5cb1a1e465.html">gr-uhd</a></li><li class="navelem"><a class="el" href="dir_9fd9d6a1716b8fb1072790166d7db107.html">include</a></li><li class="navelem"><a class="el" href="gr__uhd__usrp__sink_8h.html">gr_uhd_usrp_sink.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:35 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
