Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > eb4b034508697cc17e7c9cfffe7f772b > files > 130

uhd-doc-3.7.2-3.mga5.noarch.rpm

<!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_manager 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
   &#160;<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&#160;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&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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__manager.html">dboard_manager</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classuhd_1_1usrp_1_1dboard__manager-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">uhd::usrp::dboard_manager Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="dboard__manager_8hpp_source.html">dboard_manager.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for uhd::usrp::dboard_manager:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classuhd_1_1usrp_1_1dboard__manager.png" usemap="#uhd::usrp::dboard_manager_map" alt=""/>
  <map id="uhd::usrp::dboard_manager_map" name="uhd::usrp::dboard_manager_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:a073c6f31cb50ca49cf2dd5a43cb986cd"><td class="memItemLeft" align="right" valign="top">typedef boost::shared_ptr<br class="typebreak" />
&lt; <a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html">dboard_manager</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a073c6f31cb50ca49cf2dd5a43cb986cd">sptr</a></td></tr>
<tr class="separator:a073c6f31cb50ca49cf2dd5a43cb986cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a576e4229a9181b0c2eec151e4c7ea72c"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classuhd_1_1usrp_1_1dboard__base.html#a17980b65c7348bae9a6efa1f2c83ff92">dboard_base::sptr</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a576e4229a9181b0c2eec151e4c7ea72c">dboard_ctor_t</a> )(<a class="el" href="classuhd_1_1usrp_1_1dboard__base.html#a06a259a52099834ead53e8a00dc620c0">dboard_base::ctor_args_t</a>)</td></tr>
<tr class="separator:a576e4229a9181b0c2eec151e4c7ea72c"><td class="memSeparator" colspan="2">&#160;</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:a28f258b1440818c7619c6dfba3b36465"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a28f258b1440818c7619c6dfba3b36465">register_dboard</a> (const <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> &amp;dboard_id, <a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a576e4229a9181b0c2eec151e4c7ea72c">dboard_ctor_t</a> dboard_ctor, const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;subdev_names=std::vector&lt; std::string &gt;(1,&quot;0&quot;))</td></tr>
<tr class="separator:a28f258b1440818c7619c6dfba3b36465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38b0096fdb816819526889abf436b83f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a38b0096fdb816819526889abf436b83f">register_dboard</a> (const <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> &amp;rx_dboard_id, const <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> &amp;tx_dboard_id, <a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a576e4229a9181b0c2eec151e4c7ea72c">dboard_ctor_t</a> dboard_ctor, const std::string &amp;name, const std::vector&lt; std::string &gt; &amp;subdev_names=std::vector&lt; std::string &gt;(1,&quot;0&quot;))</td></tr>
<tr class="separator:a38b0096fdb816819526889abf436b83f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c3274784af8566dee301faaa021b2d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a073c6f31cb50ca49cf2dd5a43cb986cd">sptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#ae2c3274784af8566dee301faaa021b2d">make</a> (<a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> rx_dboard_id, <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> tx_dboard_id, <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> gdboard_id, <a class="el" href="classuhd_1_1usrp_1_1dboard__iface.html#a59c880b1ce74b17f9aec67426d37a4c8">dboard_iface::sptr</a> iface, <a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">property_tree::sptr</a> subtree)</td></tr>
<tr class="separator:ae2c3274784af8566dee301faaa021b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A daughter board subdev <a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html">dboard_manager</a> class. Create subdev instances for each subdev on a dboard. Provide wax::obj access to the subdevs inside. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a576e4229a9181b0c2eec151e4c7ea72c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classuhd_1_1usrp_1_1dboard__base.html#a17980b65c7348bae9a6efa1f2c83ff92">dboard_base::sptr</a>(* uhd::usrp::dboard_manager::dboard_ctor_t)(<a class="el" href="classuhd_1_1usrp_1_1dboard__base.html#a06a259a52099834ead53e8a00dc620c0">dboard_base::ctor_args_t</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a073c6f31cb50ca49cf2dd5a43cb986cd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef boost::shared_ptr&lt;<a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html">dboard_manager</a>&gt; <a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a073c6f31cb50ca49cf2dd5a43cb986cd">uhd::usrp::dboard_manager::sptr</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae2c3274784af8566dee301faaa021b2d"></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__manager.html#a073c6f31cb50ca49cf2dd5a43cb986cd">sptr</a> uhd::usrp::dboard_manager::make </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a>&#160;</td>
          <td class="paramname"><em>rx_dboard_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a>&#160;</td>
          <td class="paramname"><em>tx_dboard_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a>&#160;</td>
          <td class="paramname"><em>gdboard_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classuhd_1_1usrp_1_1dboard__iface.html#a59c880b1ce74b17f9aec67426d37a4c8">dboard_iface::sptr</a>&#160;</td>
          <td class="paramname"><em>iface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">property_tree::sptr</a>&#160;</td>
          <td class="paramname"><em>subtree</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Make a new dboard manager. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">rx_dboard_id</td><td>the id of the rx dboard </td></tr>
    <tr><td class="paramname">tx_dboard_id</td><td>the id of the tx dboard </td></tr>
    <tr><td class="paramname">gdboard_id</td><td>the id of the grand-dboard </td></tr>
    <tr><td class="paramname">iface</td><td>the custom dboard interface </td></tr>
    <tr><td class="paramname">subtree</td><td>the subtree to load with props </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an sptr to the new dboard manager </dd></dl>

</div>
</div>
<a class="anchor" id="a28f258b1440818c7619c6dfba3b36465"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void uhd::usrp::dboard_manager::register_dboard </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> &amp;&#160;</td>
          <td class="paramname"><em>dboard_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a576e4229a9181b0c2eec151e4c7ea72c">dboard_ctor_t</a>&#160;</td>
          <td class="paramname"><em>dboard_ctor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
          <td class="paramname"><em>subdev_names</em> = <code>std::vector&lt;&#160;std::string&#160;&gt;(1,&quot;0&quot;)</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Register a rx or tx dboard into the system. For single subdevice boards, omit subdev_names. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dboard_id</td><td>the dboard id (rx or tx) </td></tr>
    <tr><td class="paramname">dboard_ctor</td><td>the dboard constructor function pointer </td></tr>
    <tr><td class="paramname">name</td><td>the canonical name for the dboard represented </td></tr>
    <tr><td class="paramname">subdev_names</td><td>the names of the subdevs on this dboard </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a38b0096fdb816819526889abf436b83f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void uhd::usrp::dboard_manager::register_dboard </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> &amp;&#160;</td>
          <td class="paramname"><em>rx_dboard_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classuhd_1_1usrp_1_1dboard__id__t.html">dboard_id_t</a> &amp;&#160;</td>
          <td class="paramname"><em>tx_dboard_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classuhd_1_1usrp_1_1dboard__manager.html#a576e4229a9181b0c2eec151e4c7ea72c">dboard_ctor_t</a>&#160;</td>
          <td class="paramname"><em>dboard_ctor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
          <td class="paramname"><em>subdev_names</em> = <code>std::vector&lt;&#160;std::string&#160;&gt;(1,&quot;0&quot;)</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Register an xcvr dboard into the system. For single subdevice boards, omit subdev_names. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">rx_dboard_id</td><td>the rx unit dboard id </td></tr>
    <tr><td class="paramname">tx_dboard_id</td><td>the tx unit dboard id </td></tr>
    <tr><td class="paramname">dboard_ctor</td><td>the dboard constructor function pointer </td></tr>
    <tr><td class="paramname">name</td><td>the canonical name for the dboard represented </td></tr>
    <tr><td class="paramname">subdev_names</td><td>the names of the subdevs on this dboard </td></tr>
  </table>
  </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__manager_8hpp_source.html">dboard_manager.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>