<!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::stream_args_t Struct 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="structuhd_1_1stream__args__t.html">stream_args_t</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structuhd_1_1stream__args__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::stream_args_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="stream_8hpp_source.html">stream.hpp</a>></code></p>
<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:aa54b7dc3e2c71d11c774d8b4a15984cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1stream__args__t.html#aa54b7dc3e2c71d11c774d8b4a15984cc">stream_args_t</a> (const std::string &cpu="", const std::string &otw="")</td></tr>
<tr class="memdesc:aa54b7dc3e2c71d11c774d8b4a15984cc"><td class="mdescLeft"> </td><td class="mdescRight">Convenience constructor for streamer args. <a href="#aa54b7dc3e2c71d11c774d8b4a15984cc">More...</a><br /></td></tr>
<tr class="separator:aa54b7dc3e2c71d11c774d8b4a15984cc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a602a64b4937a85dba84e7f724387e252"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1stream__args__t.html#a602a64b4937a85dba84e7f724387e252">cpu_format</a></td></tr>
<tr class="separator:a602a64b4937a85dba84e7f724387e252"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ba0e946d2f83f7ac085f4f4e2ce9578"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1stream__args__t.html#a0ba0e946d2f83f7ac085f4f4e2ce9578">otw_format</a></td></tr>
<tr class="separator:a0ba0e946d2f83f7ac085f4f4e2ce9578"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4463f2eec2cc7ee70f84baacbb26e1ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuhd_1_1device__addr__t.html">device_addr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1stream__args__t.html#a4463f2eec2cc7ee70f84baacbb26e1ef">args</a></td></tr>
<tr class="separator:a4463f2eec2cc7ee70f84baacbb26e1ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebfb903c0cb6c040d78ef90917e55a61"><td class="memItemLeft" align="right" valign="top">std::vector< size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1stream__args__t.html#aebfb903c0cb6c040d78ef90917e55a61">channels</a></td></tr>
<tr class="separator:aebfb903c0cb6c040d78ef90917e55a61"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A struct of parameters to construct a streamer.</p>
<p>Note: Not all combinations of CPU and OTW format have conversion support. You may however write and register your own conversion routines. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa54b7dc3e2c71d11c774d8b4a15984cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uhd::stream_args_t::stream_args_t </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>cpu</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>otw</em> = <code>""</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience constructor for streamer args. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4463f2eec2cc7ee70f84baacbb26e1ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuhd_1_1device__addr__t.html">device_addr_t</a> uhd::stream_args_t::args</td>
</tr>
</table>
</div><div class="memdoc">
<p>The args parameter is used to pass arbitrary key/value pairs. Possible keys used by args (depends on implementation):</p>
<ul>
<li>fullscale: specifies the full-scale amplitude when using floats. By default, the fullscale amplitude under floating point is 1.0. Set the "fullscale" to scale the samples in the host to the expected input range and/or output range of your application.</li>
<li>peak: specifies a fractional sample level to calculate scaling with the sc8 wire format. When using sc8 samples over the wire, the device must scale samples (both on the host and in the device) to satisfy the dynamic range needs. The peak value specifies a fraction of the maximum sample level (1.0 = 100%). Set peak to max_sample_level/full_scale_level to ensure optimum dynamic range.</li>
<li>underflow_policy: how the TX DSP should recover from underflow. Possible options are "next_burst" or "next_packet". In the "next_burst" mode, the DSP drops incoming packets until a new burst is started. In the "next_packet" mode, the DSP starts transmitting again at the next packet.</li>
<li>spp: (samples per packet) controls the size of RX packets. When not specified, the packets are always maximum frame size. Users should specify this option to request smaller than default packets, probably with the intention of reducing packet latency.</li>
</ul>
<p>The following are not implemented, but are listed for conceptual purposes:</p><ul>
<li>function: magnitude or phase/magnitude</li>
<li>units: numeric units like counts or dBm </li>
</ul>
</div>
</div>
<a class="anchor" id="aebfb903c0cb6c040d78ef90917e55a61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<size_t> uhd::stream_args_t::channels</td>
</tr>
</table>
</div><div class="memdoc">
<p>The channels is a list of channel numbers. Leave this blank to default to channel 0. Set channels for a multi-channel application. Channel mapping depends on the front-end selection. </p>
</div>
</div>
<a class="anchor" id="a602a64b4937a85dba84e7f724387e252"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string uhd::stream_args_t::cpu_format</td>
</tr>
</table>
</div><div class="memdoc">
<p>The CPU format is a string that describes the format of host memory. Conversions for the following CPU formats have been implemented:</p><ul>
<li>fc64 - complex<double></li>
<li>fc32 - complex<float></li>
<li>sc16 - complex<int16_t></li>
<li>sc8 - complex<int8_t></li>
</ul>
<p>The following are not implemented, but are listed to demonstrate naming convention:</p><ul>
<li>f32 - float</li>
<li>f64 - double</li>
<li>s16 - int16_t</li>
<li>s8 - int8_t </li>
</ul>
</div>
</div>
<a class="anchor" id="a0ba0e946d2f83f7ac085f4f4e2ce9578"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string uhd::stream_args_t::otw_format</td>
</tr>
</table>
</div><div class="memdoc">
<p>The OTW format is a string that describes the format over-the-wire. The following over-the-wire formats have been implemented:</p><ul>
<li>sc16 - Q16 I16</li>
<li>sc8 - Q8_1 I8_1 Q8_0 I8_0</li>
</ul>
<p>The following are not implemented, but are listed to demonstrate naming convention:</p><ul>
<li>s16 - R16_1 R16_0</li>
<li>s8 - R8_3 R8_2 R8_1 R8_0 </li>
</ul>
</div>
</div>
<hr/>The documentation for this struct 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>
