<!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::usrp::dboard_id_t 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="namespaceuhd_1_1usrp.html">usrp</a></li><li class="navelem"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classuhd_1_1usrp_1_1dboard__id__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::usrp::dboard_id_t Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="dboard__id_8hpp_source.html">dboard_id.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for uhd::usrp::dboard_id_t:</div>
<div class="dyncontent">
<div class="center">
<img src="classuhd_1_1usrp_1_1dboard__id__t.png" usemap="#uhd::usrp::dboard_id_t_map" alt=""/>
<map id="uhd::usrp::dboard_id_t_map" name="uhd::usrp::dboard_id_t_map">
</map>
</div></div>
<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:a8b445bde6078463fe42eae02c1a1c4b4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#a8b445bde6078463fe42eae02c1a1c4b4">dboard_id_t</a> (boost::uint16_t id=0xffff)</td></tr>
<tr class="separator:a8b445bde6078463fe42eae02c1a1c4b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4be2e2701d6ab3454a49696caed21b1c"><td class="memItemLeft" align="right" valign="top">boost::uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#a4be2e2701d6ab3454a49696caed21b1c">to_uint16</a> (void) const </td></tr>
<tr class="separator:a4be2e2701d6ab3454a49696caed21b1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad734430061557f447d53b7d748ca3230"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#ad734430061557f447d53b7d748ca3230">to_string</a> (void) const </td></tr>
<tr class="separator:ad734430061557f447d53b7d748ca3230"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a604f2c2d9cb350032888894212d9a212"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#a604f2c2d9cb350032888894212d9a212">to_cname</a> (void) const </td></tr>
<tr class="separator:a604f2c2d9cb350032888894212d9a212"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a962e45cddce3583bc9a5d5cad83bb332"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#a962e45cddce3583bc9a5d5cad83bb332">to_pp_string</a> (void) const </td></tr>
<tr class="separator:a962e45cddce3583bc9a5d5cad83bb332"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abba3b387fa327262a7e310dd28a2eb84"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#abba3b387fa327262a7e310dd28a2eb84">none</a> (void)</td></tr>
<tr class="separator:abba3b387fa327262a7e310dd28a2eb84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e9071c3237ec4ff53f9844f78972620"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#a8e9071c3237ec4ff53f9844f78972620">from_uint16</a> (boost::uint16_t uint16)</td></tr>
<tr class="separator:a8e9071c3237ec4ff53f9844f78972620"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98fde2a2e0023f21530955a012658553"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html#a98fde2a2e0023f21530955a012658553">from_string</a> (const std::string &string)</td></tr>
<tr class="separator:a98fde2a2e0023f21530955a012658553"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8b445bde6078463fe42eae02c1a1c4b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uhd::usrp::dboard_id_t::dboard_id_t </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>id</em> = <code>0xffff</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a dboard id from an integer. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>the integer representation </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a98fde2a2e0023f21530955a012658553"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> uhd::usrp::dboard_id_t::from_string </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>string</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new dboard id from a string representation. If the string has a 0x prefix, it will be parsed as hex. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>a numeric string, possibly hex </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new dboard id containing the integer </dd></dl>
</div>
</div>
<a class="anchor" id="a8e9071c3237ec4ff53f9844f78972620"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> uhd::usrp::dboard_id_t::from_uint16 </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>uint16</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new dboard id from an integer representation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uint16</td><td>an unsigned 16 bit integer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new dboard id containing the integer </dd></dl>
</div>
</div>
<a class="anchor" id="abba3b387fa327262a7e310dd28a2eb84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> uhd::usrp::dboard_id_t::none </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtain a dboard id that represents no dboard. </p><dl class="section return"><dt>Returns</dt><dd>the dboard id with the 0xffff id. </dd></dl>
</div>
</div>
<a class="anchor" id="a604f2c2d9cb350032888894212d9a212"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string uhd::usrp::dboard_id_t::to_cname </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 dboard id represented as a canonical name. </p><dl class="section return"><dt>Returns</dt><dd>the canonical string representation </dd></dl>
</div>
</div>
<a class="anchor" id="a962e45cddce3583bc9a5d5cad83bb332"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string uhd::usrp::dboard_id_t::to_pp_string </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 pretty print representation of this dboard id. </p><dl class="section return"><dt>Returns</dt><dd>a string with the dboard name and id number </dd></dl>
</div>
</div>
<a class="anchor" id="ad734430061557f447d53b7d748ca3230"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string uhd::usrp::dboard_id_t::to_string </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 dboard id represented as an integer. </p><dl class="section return"><dt>Returns</dt><dd>a hex string representation with 0x prefix </dd></dl>
</div>
</div>
<a class="anchor" id="a4be2e2701d6ab3454a49696caed21b1c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::uint16_t uhd::usrp::dboard_id_t::to_uint16 </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 dboard id represented as an integer. </p><dl class="section return"><dt>Returns</dt><dd>an unsigned 16 bit integer representation </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/uhd/usrp/<a class="el" href="dboard__id_8hpp_source.html">dboard_id.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:54 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
>
124
