<!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::transport::usb_device_handle 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_1transport.html">transport</a></li><li class="navelem"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html">usb_device_handle</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-static-methods">Static Public Member Functions</a> |
<a href="classuhd_1_1transport_1_1usb__device__handle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::transport::usb_device_handle Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="usb__device__handle_8hpp_source.html">usb_device_handle.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for uhd::transport::usb_device_handle:</div>
<div class="dyncontent">
<div class="center">
<img src="classuhd_1_1transport_1_1usb__device__handle.png" usemap="#uhd::transport::usb_device_handle_map" alt=""/>
<map id="uhd::transport::usb_device_handle_map" name="uhd::transport::usb_device_handle_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:a83bb842365c68add8a095d2817e603b7"><td class="memItemLeft" align="right" valign="top">typedef boost::shared_ptr<br class="typebreak" />
< <a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html">usb_device_handle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a83bb842365c68add8a095d2817e603b7">sptr</a></td></tr>
<tr class="separator:a83bb842365c68add8a095d2817e603b7"><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:a43f7e19a67c87cfde15931699dad7818"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a43f7e19a67c87cfde15931699dad7818">get_serial</a> () const =0</td></tr>
<tr class="separator:a43f7e19a67c87cfde15931699dad7818"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1842dbe899ac157980c3ab4af3149017"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a1842dbe899ac157980c3ab4af3149017">get_manufacturer</a> () const =0</td></tr>
<tr class="separator:a1842dbe899ac157980c3ab4af3149017"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68760f0823730d8ff9e17b6bf5be2ed5"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a68760f0823730d8ff9e17b6bf5be2ed5">get_product</a> () const =0</td></tr>
<tr class="separator:a68760f0823730d8ff9e17b6bf5be2ed5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a020be69e08d3328d4c047003a7a4819c"><td class="memItemLeft" align="right" valign="top">virtual boost::uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a020be69e08d3328d4c047003a7a4819c">get_vendor_id</a> () const =0</td></tr>
<tr class="separator:a020be69e08d3328d4c047003a7a4819c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaab8f08bf5b7a2f52e54c3faea4a420e"><td class="memItemLeft" align="right" valign="top">virtual boost::uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#aaab8f08bf5b7a2f52e54c3faea4a420e">get_product_id</a> () const =0</td></tr>
<tr class="separator:aaab8f08bf5b7a2f52e54c3faea4a420e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d0568f3223ba2f980f5386a3594ccdf"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a7d0568f3223ba2f980f5386a3594ccdf">firmware_loaded</a> ()=0</td></tr>
<tr class="separator:a7d0568f3223ba2f980f5386a3594ccdf"><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:a8e7319f6779caeafc5df59e72b154dbe"><td class="memItemLeft" align="right" valign="top">static std::vector<br class="typebreak" />
< <a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a83bb842365c68add8a095d2817e603b7">usb_device_handle::sptr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a8e7319f6779caeafc5df59e72b154dbe">get_device_list</a> (boost::uint16_t vid, boost::uint16_t pid)</td></tr>
<tr class="separator:a8e7319f6779caeafc5df59e72b154dbe"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Device handle class that represents a USB device Used for identifying devices on the USB bus and selecting which device is used when creating a USB transport. A minimal subset of USB descriptor fields are used. Fields can be found in the USB 2.0 specification Table 9-8 (Standard Device Descriptor). In addition to fields of the device descriptor, the interface returns the device's USB device address.</p>
<p>Note: The USB 2.0 Standard Device Descriptor contains an index rather then a true descriptor serial number string. This interface returns the actual string descriptor. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a83bb842365c68add8a095d2817e603b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::shared_ptr<<a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html">usb_device_handle</a>> <a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a83bb842365c68add8a095d2817e603b7">uhd::transport::usb_device_handle::sptr</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7d0568f3223ba2f980f5386a3594ccdf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool uhd::transport::usb_device_handle::firmware_loaded </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test whether the firmware is loaded on the device. </p><dl class="section return"><dt>Returns</dt><dd>true if firmware is loaded </dd></dl>
</div>
</div>
<a class="anchor" id="a8e7319f6779caeafc5df59e72b154dbe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector<<a class="el" href="classuhd_1_1transport_1_1usb__device__handle.html#a83bb842365c68add8a095d2817e603b7">usb_device_handle::sptr</a>> uhd::transport::usb_device_handle::get_device_list </td>
<td>(</td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>vid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint16_t </td>
<td class="paramname"><em>pid</em> </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>Return a vector of USB devices on this host </p><dl class="section return"><dt>Returns</dt><dd>a vector of USB device handles that match vid and pid </dd></dl>
</div>
</div>
<a class="anchor" id="a1842dbe899ac157980c3ab4af3149017"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string uhd::transport::usb_device_handle::get_manufacturer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the device's manufacturer identification string </p><dl class="section return"><dt>Returns</dt><dd>a string describing the device's manufacturer string </dd></dl>
</div>
</div>
<a class="anchor" id="a68760f0823730d8ff9e17b6bf5be2ed5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string uhd::transport::usb_device_handle::get_product </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the device's product identification string </p><dl class="section return"><dt>Returns</dt><dd>a string describing the device's product string </dd></dl>
</div>
</div>
<a class="anchor" id="aaab8f08bf5b7a2f52e54c3faea4a420e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boost::uint16_t uhd::transport::usb_device_handle::get_product_id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the device's Product ID (usually assigned by manufacturer) </p><dl class="section return"><dt>Returns</dt><dd>a Product ID </dd></dl>
</div>
</div>
<a class="anchor" id="a43f7e19a67c87cfde15931699dad7818"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string uhd::transport::usb_device_handle::get_serial </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the device's serial number </p><dl class="section return"><dt>Returns</dt><dd>a string describing the device's serial number </dd></dl>
</div>
</div>
<a class="anchor" id="a020be69e08d3328d4c047003a7a4819c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual boost::uint16_t uhd::transport::usb_device_handle::get_vendor_id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the device's Vendor ID (usually assigned by the USB-IF) </p><dl class="section return"><dt>Returns</dt><dd>a Vendor ID </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/uhd/transport/<a class="el" href="usb__device__handle_8hpp_source.html">usb_device_handle.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>
