<!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::device_addr_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="classuhd_1_1device__addr__t.html">device_addr_t</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classuhd_1_1device__addr__t-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">uhd::device_addr_t Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="device__addr_8hpp_source.html">device_addr.hpp</a>></code></p> <div class="dynheader"> Inheritance diagram for uhd::device_addr_t:</div> <div class="dyncontent"> <div class="center"> <img src="classuhd_1_1device__addr__t.png" usemap="#uhd::device_addr_t_map" alt=""/> <map id="uhd::device_addr_t_map" name="uhd::device_addr_t_map"> <area href="classuhd_1_1dict.html" alt="uhd::dict< std::string, std::string >" shape="rect" coords="0,0,198,24"/> </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:a01c5b69edf398e4e0e261b23b94a0cc3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1device__addr__t.html#a01c5b69edf398e4e0e261b23b94a0cc3">device_addr_t</a> (const std::string &args="")</td></tr> <tr class="separator:a01c5b69edf398e4e0e261b23b94a0cc3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6094fe2c843098eb0cc02422dfa8fb4a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1device__addr__t.html#a6094fe2c843098eb0cc02422dfa8fb4a">to_pp_string</a> (void) const </td></tr> <tr class="separator:a6094fe2c843098eb0cc02422dfa8fb4a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aee9b0eb92f2215cac4700cf36b0bd8b7"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1device__addr__t.html#aee9b0eb92f2215cac4700cf36b0bd8b7">to_string</a> (void) const </td></tr> <tr class="separator:aee9b0eb92f2215cac4700cf36b0bd8b7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7133e6079eab6d4c95f56353401f3f6"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> <tr class="memitem:ab7133e6079eab6d4c95f56353401f3f6"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuhd_1_1device__addr__t.html#ab7133e6079eab6d4c95f56353401f3f6">cast</a> (const std::string &key, const T &def) const </td></tr> <tr class="separator:ab7133e6079eab6d4c95f56353401f3f6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classuhd_1_1dict"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuhd_1_1dict')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuhd_1_1dict.html">uhd::dict< std::string, std::string ></a></td></tr> <tr class="memitem:ac22824212af73001d7a59b9cd3e9e86b inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#ac22824212af73001d7a59b9cd3e9e86b">dict</a> (void)</td></tr> <tr class="separator:ac22824212af73001d7a59b9cd3e9e86b inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4a0758fb1f969e4b9b9c9d2a98aad02f inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a4a0758fb1f969e4b9b9c9d2a98aad02f">dict</a> (InputIterator first, InputIterator last)</td></tr> <tr class="separator:a4a0758fb1f969e4b9b9c9d2a98aad02f inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a114dc49bb3350b53915621ff909d7e94 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a114dc49bb3350b53915621ff909d7e94">size</a> (void) const</td></tr> <tr class="separator:a114dc49bb3350b53915621ff909d7e94 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad0fc8208d570344c172956407052a5a7 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#ad0fc8208d570344c172956407052a5a7">keys</a> (void) const</td></tr> <tr class="separator:ad0fc8208d570344c172956407052a5a7 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a19ff838f961f876f6e3ab1a81702b0cc inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a19ff838f961f876f6e3ab1a81702b0cc">vals</a> (void) const</td></tr> <tr class="separator:a19ff838f961f876f6e3ab1a81702b0cc inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a525dda34a07a7fa4912e6fe78688991a inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a525dda34a07a7fa4912e6fe78688991a">has_key</a> (const std::string &key) const</td></tr> <tr class="separator:a525dda34a07a7fa4912e6fe78688991a inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2d88101cd952061a9520478fcb0a3013 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a2d88101cd952061a9520478fcb0a3013">get</a> (const std::string &key, const std::string &other) const</td></tr> <tr class="separator:a2d88101cd952061a9520478fcb0a3013 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0f9fa1e07fb4765a0a0985f73152cdb inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#ab0f9fa1e07fb4765a0a0985f73152cdb">get</a> (const std::string &key) const</td></tr> <tr class="separator:ab0f9fa1e07fb4765a0a0985f73152cdb inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc5a15726e80fa91f0338a0c41a1c0e5 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#afc5a15726e80fa91f0338a0c41a1c0e5">set</a> (const std::string &key, const std::string &val)</td></tr> <tr class="separator:afc5a15726e80fa91f0338a0c41a1c0e5 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a033fdf1fe1f763fd802013c2c3ac3bb8 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a033fdf1fe1f763fd802013c2c3ac3bb8">operator[]</a> (const std::string &key) const</td></tr> <tr class="separator:a033fdf1fe1f763fd802013c2c3ac3bb8 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8948ea3770b847f0142d43e28242e3e6 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#a8948ea3770b847f0142d43e28242e3e6">operator[]</a> (const std::string &key)</td></tr> <tr class="separator:a8948ea3770b847f0142d43e28242e3e6 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aecbd5d852699f74f15b66354afdb3b51 inherit pub_methods_classuhd_1_1dict"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1dict.html#aecbd5d852699f74f15b66354afdb3b51">pop</a> (const std::string &key)</td></tr> <tr class="separator:aecbd5d852699f74f15b66354afdb3b51 inherit pub_methods_classuhd_1_1dict"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Mapping of key/value pairs for locating devices on the system. When left empty, the device discovery routines will search all available transports on the system (ethernet, usb...).</p> <p>To narrow down the discovery process to a particular device, specify a transport key/value pair specific to your device.</p><ul> <li>Ex, to find a usrp2: my_dev_addr["addr"] = [resolvable_hostname_or_ip]</li> </ul> <p>The device address can also be used to pass arguments into the transport layer control to set (for example) buffer sizes.</p> <p>An arguments string, is a way to represent a device address using a single string with delimiter characters.</p><ul> <li>Ex: addr=192.168.10.2</li> <li>Ex: addr=192.168.10.2, recv_buff_size=1e6 </li> </ul> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a01c5b69edf398e4e0e261b23b94a0cc3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uhd::device_addr_t::device_addr_t </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>args</em> = <code>""</code></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a device address from an args string. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">args</td><td>the arguments string </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ab7133e6079eab6d4c95f56353401f3f6"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">T uhd::device_addr_t::cast </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const T & </td> <td class="paramname"><em>def</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</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>Lexically cast a parameter to the specified type, or use the default value if the key is not found. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">key</td><td>the key as one of the address parameters </td></tr> <tr><td class="paramname">def</td><td>the value to use when key is not present </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the casted value as type T or the default </dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname">error</td><td>when the parameter cannot be casted </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6094fe2c843098eb0cc02422dfa8fb4a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string uhd::device_addr_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>Convert a device address into a pretty print string. </p><dl class="section return"><dt>Returns</dt><dd>a printable string representing the device address </dd></dl> </div> </div> <a class="anchor" id="aee9b0eb92f2215cac4700cf36b0bd8b7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string uhd::device_addr_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>Convert the device address into an args string. The args string contains delimiter symbols. </p><dl class="section return"><dt>Returns</dt><dd>a string with delimiter markup </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>include/uhd/types/<a class="el" href="device__addr_8hpp_source.html">device_addr.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>