<!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.8"/>
<title>UHD: uhd::tx_streamer Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">UHD
 <span id="projectnumber">003.007.002-0-unknown</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="classuhd_1_1tx__streamer.html">tx_streamer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classuhd_1_1tx__streamer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::tx_streamer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="stream_8hpp_source.html">stream.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for uhd::tx_streamer:</div>
<div class="dyncontent">
<div class="center">
<img src="classuhd_1_1tx__streamer.png" usemap="#uhd::tx_streamer_map" alt=""/>
<map id="uhd::tx_streamer_map" name="uhd::tx_streamer_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a137bfe67e240e3d73ef7708155fb9827"><td class="memItemLeft" align="right" valign="top">typedef boost::shared_ptr<br class="typebreak" />
< <a class="el" href="classuhd_1_1tx__streamer.html">tx_streamer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#a137bfe67e240e3d73ef7708155fb9827">sptr</a></td></tr>
<tr class="separator:a137bfe67e240e3d73ef7708155fb9827"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06f6341bfa89bc755f262cbbfb616fbd"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classuhd_1_1ref__vector.html">ref_vector</a>< const void * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#a06f6341bfa89bc755f262cbbfb616fbd">buffs_type</a></td></tr>
<tr class="memdesc:a06f6341bfa89bc755f262cbbfb616fbd"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for a pointer to a single, or a collection of send buffers. <a href="#a06f6341bfa89bc755f262cbbfb616fbd">More...</a><br /></td></tr>
<tr class="separator:a06f6341bfa89bc755f262cbbfb616fbd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0be3c9bb6665b3ca0a5cec741a1e185a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#a0be3c9bb6665b3ca0a5cec741a1e185a">~tx_streamer</a> (void)</td></tr>
<tr class="separator:a0be3c9bb6665b3ca0a5cec741a1e185a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af32583f7633fa80a9b35d5f1fca13767"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#af32583f7633fa80a9b35d5f1fca13767">get_num_channels</a> (void) const =0</td></tr>
<tr class="memdesc:af32583f7633fa80a9b35d5f1fca13767"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of channels associated with this streamer. <a href="#af32583f7633fa80a9b35d5f1fca13767">More...</a><br /></td></tr>
<tr class="separator:af32583f7633fa80a9b35d5f1fca13767"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a842252ce51980664ae4e515101fb5070"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#a842252ce51980664ae4e515101fb5070">get_max_num_samps</a> (void) const =0</td></tr>
<tr class="memdesc:a842252ce51980664ae4e515101fb5070"><td class="mdescLeft"> </td><td class="mdescRight">Get the max number of samples per buffer per packet. <a href="#a842252ce51980664ae4e515101fb5070">More...</a><br /></td></tr>
<tr class="separator:a842252ce51980664ae4e515101fb5070"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb2e0f44810693d9da99ea1e04fad21f"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#aeb2e0f44810693d9da99ea1e04fad21f">send</a> (const <a class="el" href="classuhd_1_1tx__streamer.html#a06f6341bfa89bc755f262cbbfb616fbd">buffs_type</a> &buffs, const size_t nsamps_per_buff, const <a class="el" href="structuhd_1_1tx__metadata__t.html">tx_metadata_t</a> &metadata, const double timeout=0.1)=0</td></tr>
<tr class="separator:aeb2e0f44810693d9da99ea1e04fad21f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14eef202de5a15bb72a149a7891af208"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1tx__streamer.html#a14eef202de5a15bb72a149a7891af208">recv_async_msg</a> (<a class="el" href="structuhd_1_1async__metadata__t.html">async_metadata_t</a> &async_metadata, double timeout=0.1)=0</td></tr>
<tr class="separator:a14eef202de5a15bb72a149a7891af208"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The TX streamer is the host interface to transmitting samples. It represents the layer between the samples on the host and samples inside the device's transmit DSP processing. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a06f6341bfa89bc755f262cbbfb616fbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classuhd_1_1ref__vector.html">ref_vector</a><const void *> <a class="el" href="classuhd_1_1tx__streamer.html#a06f6341bfa89bc755f262cbbfb616fbd">uhd::tx_streamer::buffs_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for a pointer to a single, or a collection of send buffers. </p>
</div>
</div>
<a class="anchor" id="a137bfe67e240e3d73ef7708155fb9827"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::shared_ptr<<a class="el" href="classuhd_1_1tx__streamer.html">tx_streamer</a>> <a class="el" href="classuhd_1_1tx__streamer.html#a137bfe67e240e3d73ef7708155fb9827">uhd::tx_streamer::sptr</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0be3c9bb6665b3ca0a5cec741a1e185a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uhd::tx_streamer::~tx_streamer </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a842252ce51980664ae4e515101fb5070"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t uhd::tx_streamer::get_max_num_samps </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the max number of samples per buffer per packet. </p>
</div>
</div>
<a class="anchor" id="af32583f7633fa80a9b35d5f1fca13767"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t uhd::tx_streamer::get_num_channels </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of channels associated with this streamer. </p>
</div>
</div>
<a class="anchor" id="a14eef202de5a15bb72a149a7891af208"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool uhd::tx_streamer::recv_async_msg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structuhd_1_1async__metadata__t.html">async_metadata_t</a> & </td>
<td class="paramname"><em>async_metadata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>timeout</em> = <code>0.1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive and asynchronous message from this TX stream. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">async_metadata</td><td>the metadata to be filled in </td></tr>
<tr><td class="paramname">timeout</td><td>the timeout in seconds to wait for a message </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true when the async_metadata is valid, false for timeout </dd></dl>
</div>
</div>
<a class="anchor" id="aeb2e0f44810693d9da99ea1e04fad21f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t uhd::tx_streamer::send </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuhd_1_1tx__streamer.html#a06f6341bfa89bc755f262cbbfb616fbd">buffs_type</a> & </td>
<td class="paramname"><em>buffs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>nsamps_per_buff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structuhd_1_1tx__metadata__t.html">tx_metadata_t</a> & </td>
<td class="paramname"><em>metadata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double </td>
<td class="paramname"><em>timeout</em> = <code>0.1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Send buffers containing samples described by the metadata.</p>
<p>Send handles fragmentation as follows: If the buffer has more items than the maximum per packet, the send method will fragment the samples across several packets. Send will respect the burst flags when fragmenting to ensure that start of burst can only be set on the first fragment and that end of burst can only be set on the final fragment.</p>
<p>This is a blocking call and will not return until the number of samples returned have been read out of each buffer. Under a timeout condition, the number of samples returned may be less than the number of samples specified.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffs</td><td>a vector of read-only memory containing samples </td></tr>
<tr><td class="paramname">nsamps_per_buff</td><td>the number of samples to send, per buffer </td></tr>
<tr><td class="paramname">metadata</td><td>data describing the buffer's contents </td></tr>
<tr><td class="paramname">timeout</td><td>the timeout in seconds to wait on a packet </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of samples sent </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/uhd/<a class="el" href="stream_8hpp_source.html">stream.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
eb4b034508697cc17e7c9cfffe7f772b
>
files
>
116
