<!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::otw_type_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_1otw__type__t.html">otw_type_t</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="#pub-attribs">Public Attributes</a> | <a href="structuhd_1_1otw__type__t-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">uhd::otw_type_t Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="deprecated_8hpp_source.html">deprecated.hpp</a>></code></p> <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:a3e813d310c7c73335620010ee9648983"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="structuhd_1_1otw__type__t.html#a3e813d310c7c73335620010ee9648983af2dc214b6aef4ba3caa49b18041867b6">BO_NATIVE</a> = int('='), <a class="el" href="structuhd_1_1otw__type__t.html#a3e813d310c7c73335620010ee9648983a0c2f7178dbea0ef02c45bae7a1d8d646">BO_LITTLE_ENDIAN</a> = int('<'), <a class="el" href="structuhd_1_1otw__type__t.html#a3e813d310c7c73335620010ee9648983a5c9d721ec8edfb899b1704cd70904be4">BO_BIG_ENDIAN</a> = int('>'), <a class="el" href="structuhd_1_1otw__type__t.html#a3e813d310c7c73335620010ee9648983aa26e4bff795c8269b2db19aa887c2b4c">BO_NOT_APPLICABLE</a> = int('|') }</td></tr> <tr class="separator:a3e813d310c7c73335620010ee9648983"><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:a037d455f5f07ac64502a185c2ddb3733"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1otw__type__t.html#a037d455f5f07ac64502a185c2ddb3733">get_sample_size</a> (void) const </td></tr> <tr class="separator:a037d455f5f07ac64502a185c2ddb3733"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a58457911e05dd159703eec1f56ac2e1d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1otw__type__t.html#a58457911e05dd159703eec1f56ac2e1d">otw_type_t</a> (void)</td></tr> <tr class="separator:a58457911e05dd159703eec1f56ac2e1d"><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:a19b746ec4606fb18d236ae2895fee9a7"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1otw__type__t.html#a19b746ec4606fb18d236ae2895fee9a7">width</a></td></tr> <tr class="separator:a19b746ec4606fb18d236ae2895fee9a7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b0f8811f074ad61198655e5fa903144"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1otw__type__t.html#a7b0f8811f074ad61198655e5fa903144">shift</a></td></tr> <tr class="separator:a7b0f8811f074ad61198655e5fa903144"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d9ea1457c64ae68b3db89be5a5288a4"><td class="memItemLeft" align="right" valign="top">enum uhd::otw_type_t:: { ... }  </td><td class="memItemRight" valign="bottom"><a class="el" href="structuhd_1_1otw__type__t.html#a8d9ea1457c64ae68b3db89be5a5288a4">byteorder</a></td></tr> <tr class="separator:a8d9ea1457c64ae68b3db89be5a5288a4"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Description for over-the-wire integers: The DSP units in the FPGA deal with signed 16-bit integers. The width and shift define the translation between OTW and DSP, defined by the following relation: otw_int = dsp_int >> shift</p> <p>Note: possible combinations of width, shift, and byteorder depend on the internals of the FPGA. Not all are supported! </p> </div><h2 class="groupheader">Member Enumeration Documentation</h2> <a class="anchor" id="a3e813d310c7c73335620010ee9648983"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Constants for byte order (borrowed from numpy's dtype) </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a3e813d310c7c73335620010ee9648983af2dc214b6aef4ba3caa49b18041867b6"></a>BO_NATIVE </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a3e813d310c7c73335620010ee9648983a0c2f7178dbea0ef02c45bae7a1d8d646"></a>BO_LITTLE_ENDIAN </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a3e813d310c7c73335620010ee9648983a5c9d721ec8edfb899b1704cd70904be4"></a>BO_BIG_ENDIAN </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a3e813d310c7c73335620010ee9648983aa26e4bff795c8269b2db19aa887c2b4c"></a>BO_NOT_APPLICABLE </td><td class="fielddoc"> </td></tr> </table> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a58457911e05dd159703eec1f56ac2e1d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uhd::otw_type_t::otw_type_t </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a037d455f5f07ac64502a185c2ddb3733"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t uhd::otw_type_t::get_sample_size </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get the sample size of this otw type. </p><dl class="section return"><dt>Returns</dt><dd>the size of a sample in bytes </dd></dl> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a8d9ea1457c64ae68b3db89be5a5288a4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum { ... } uhd::otw_type_t::byteorder</td> </tr> </table> </div><div class="memdoc"> <p>Constants for byte order (borrowed from numpy's dtype) </p> </div> </div> <a class="anchor" id="a7b0f8811f074ad61198655e5fa903144"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t uhd::otw_type_t::shift</td> </tr> </table> </div><div class="memdoc"> <p>Shift of an over-the-wire integer in bits. otw_int = dsp_int >> shift dsp_int = otw_int << shift </p> </div> </div> <a class="anchor" id="a19b746ec4606fb18d236ae2895fee9a7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t uhd::otw_type_t::width</td> </tr> </table> </div><div class="memdoc"> <p>Width of an over-the-wire integer in bits. </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li>include/uhd/<a class="el" href="deprecated_8hpp_source.html">deprecated.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>