URL
https://opencores.org/ocsvn/usb_fpga_2_14/usb_fpga_2_14/trunk
Subversion Repositories usb_fpga_2_14
[/] [usb_fpga_2_14/] [trunk/] [docs/] [java/] [ztex/] [ZtexScanBus1.html] - Rev 2
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:13 CET 2017 -->
<title>ZtexScanBus1</title>
<meta name="date" content="2017-03-22">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ZtexScanBus1";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/ZtexImgFile1.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexUsbReader.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexScanBus1.html" target="_top">Frames</a></li>
<li><a href="ZtexScanBus1.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ztex</div>
<h2 title="Class ZtexScanBus1" class="title">Class ZtexScanBus1</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ztex.ZtexScanBus1</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ZtexScanBus1</span>
extends java.lang.Object</pre>
<div class="block">A class for scanning the USB for EZ-USB devices.
The devices found are stored as a list of <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a> instances.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexScanBus1.html#ZtexScanBus1(int,%20int,%20boolean,%20boolean)">ZtexScanBus1</a></strong>(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet)</code>
<div class="block">Scans the USB for suitable devices and constructs a list of them.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexScanBus1.html#ZtexScanBus1(int,%20int,%20boolean,%20boolean,%20int)">ZtexScanBus1</a></strong>(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet,
int interfaceVersion)</code>
<div class="block">Scans the USB for suitable devices and constructs a list of them.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexScanBus1.html#ZtexScanBus1(int,%20int,%20boolean,%20boolean,%20int,%20java.lang.String)">ZtexScanBus1</a></strong>(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet,
int interfaceVersion,
java.lang.String snString)</code>
<div class="block">Scans the USB for suitable devices and constructs a list of them.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexScanBus1.html#ZtexScanBus1(int,%20int,%20boolean,%20boolean,%20int,%20java.lang.String,%20int,%20int,%20int,%20int)">ZtexScanBus1</a></strong>(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet,
int interfaceVersion,
java.lang.String snString,
int productId0,
int productId1,
int productId2,
int productId3)</code>
<div class="block">Scans the USB for suitable devices and constructs a list of them.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</a></code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexScanBus1.html#device(int)">device</a></strong>(int i)</code>
<div class="block">Returns a device from the list of devices.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexScanBus1.html#finalize()">finalize</a></strong>()</code>
<div class="block">Releases all resources.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexScanBus1.html#numberOfDevices()">numberOfDevices</a></strong>()</code>
<div class="block">Returns the number of devices found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexScanBus1.html#printBus(java.io.PrintStream)">printBus</a></strong>(java.io.PrintStream out)</code>
<div class="block">Prints out a list of devices found.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexScanBus1.html#ref()">ref</a></strong>()</code>
<div class="block">Increases reference counter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexScanBus1.html#unref()">unref</a></strong>()</code>
<div class="block">Decreases reference counter and releases resources if 0 is reached.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ZtexScanBus1(int, int, boolean, boolean, int, java.lang.String, int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZtexScanBus1</h4>
<pre>public ZtexScanBus1(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet,
int interfaceVersion,
java.lang.String snString,
int productId0,
int productId1,
int productId2,
int productId3)</pre>
<div class="block">Scans the USB for suitable devices and constructs a list of them.
Four kinds of search filters can be applied
<ol>
<li> usbVendorId and usbProductId can be used to search for devices with a given vendor and product ID. These devices must provide a ZTEX descriptor 1.</li>
<li> If a certain interface version is required, it can be specified using interfaceVersion. </li>
<li> Incompatible devices can be excluded by the specification of the ZTEX product ID's, see <a href="../ztex/ZtexDevice1.html#compatible(int,%20int,%20int,%20int)"><code>ZtexDevice1.compatible(int,int,int,int)</code></a>. </li>
<li> If scanUnconfigured is true, also devices without ZTEX Firmware and devices with Cypress EZ-USB USB are considered</li>
<li> If more than one device is present a single device can be selected by serial number. </li>
</ol>
<a href="../ztex/ZtexScanBus1.html#unref()"><code>unref()</code></a> must be called if the class is not used anymore.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usbVendorId</code> - USB vendor ID of the device to be searched for</dd><dd><code>usbProductId</code> - USB product ID of the device to be searched for</dd><dd><code>scanUnconfigured</code> - if true, scan for unconfigured devices and devices with Cypress EZ-USB USB ID's</dd><dd><code>quiet</code> - if true, don't print any warnings</dd><dd><code>interfaceVersion</code> - The required interface version (<0 if no interface version is required)</dd><dd><code>snString</code> - The serial number of the device</dd><dd><code>productId0</code> - Byte 0 of a given ZTEX product ID (≤0 if not to be considered)</dd><dd><code>productId1</code> - Byte 1 of a given ZTEX product ID (≤0 if not to be considered)</dd><dd><code>productId2</code> - Byte 2 of a given ZTEX product ID (≤0 if not to be considered)</dd><dd><code>productId3</code> - Byte 3 of a given ZTEX product ID (≤0 if not to be considered)</dd></dl>
</li>
</ul>
<a name="ZtexScanBus1(int, int, boolean, boolean, int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZtexScanBus1</h4>
<pre>public ZtexScanBus1(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet,
int interfaceVersion,
java.lang.String snString)</pre>
<div class="block">Scans the USB for suitable devices and constructs a list of them.
Three kinds of search filters can be applied
<ol>
<li> usbVendorId and usbProductId can be used to search for devices with a given vendor and product ID. These devices must provide a ZTEX descriptor 1.</li>
<li> If a certain interface version is required, it can be specified using interfaceVersion. </li>
<li> If scanUnconfigured is true, also devices without ZTEX Firmware and devices with Cypress EZ-USB USB are considered</li>
<li> In multi device environment a single device can be selected by giving a serial number. </li>
</ol></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usbVendorId</code> - USB vendor ID of the device to be searched for</dd><dd><code>usbProductId</code> - USB product ID of the device to be searched for</dd><dd><code>scanUnconfigured</code> - if true, scan for unconfigured devices and devices with Cypress EZ-USB USB ID's</dd><dd><code>quiet</code> - if true, don't print any warnings</dd><dd><code>interfaceVersion</code> - The required interface version (<0 if no interface version is required)</dd><dd><code>snString</code> - The serial number of the device</dd></dl>
</li>
</ul>
<a name="ZtexScanBus1(int, int, boolean, boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZtexScanBus1</h4>
<pre>public ZtexScanBus1(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet,
int interfaceVersion)</pre>
<div class="block">Scans the USB for suitable devices and constructs a list of them.
Three kinds of search filters can be applied
<ol>
<li> usbVendorId and usbProductId can be used to search for devices with a given vendor and product ID. These devices must provide a ZTEX descriptor 1.</li>
<li> If a certain interface version is required, it can be specified using interfaceVersion. </li>
<li> If scanUnconfigured is true, also devices without ZTEX Firmware and devices with Cypress EZ-USB USB are considered</li>
</ol></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usbVendorId</code> - USB vendor ID of the device to be searched for</dd><dd><code>usbProductId</code> - USB product ID of the device to be searched for</dd><dd><code>scanUnconfigured</code> - if true, scan for unconfigured devices and devices with Cypress EZ-USB USB ID's</dd><dd><code>quiet</code> - if true, don't print any warnings</dd><dd><code>interfaceVersion</code> - The required interface version (<0 if no interface version is required)</dd></dl>
</li>
</ul>
<a name="ZtexScanBus1(int, int, boolean, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZtexScanBus1</h4>
<pre>public ZtexScanBus1(int usbVendorId,
int usbProductId,
boolean scanUnconfigured,
boolean quiet)</pre>
<div class="block">Scans the USB for suitable devices and constructs a list of them.
Two kinds of search filters can be applied
<ol>
<li> usbVendorId and usbProductId can be used to search for devices with a given vendor and product ID. These devices must provide a ZTEX descriptor 1.</li>
<li> If scanUnconfigured is true, also devices without ZTEX Firmware and devices with Cypress EZ-USB USB are considered</li>
</ol></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usbVendorId</code> - USB vendor ID of the device to be searched for</dd><dd><code>usbProductId</code> - USB product ID of the device to be searched for</dd><dd><code>scanUnconfigured</code> - if true, scan for unconfigured devices and devices with Cypress EZ-USB USB ID's</dd><dd><code>quiet</code> - if true, don't print any warnings</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="printBus(java.io.PrintStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printBus</h4>
<pre>public void printBus(java.io.PrintStream out)</pre>
<div class="block">Prints out a list of devices found.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - Where the output is to be printed to.</dd></dl>
</li>
</ul>
<a name="numberOfDevices()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numberOfDevices</h4>
<pre>public final int numberOfDevices()</pre>
<div class="block">Returns the number of devices found.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of devices found.</dd></dl>
</li>
</ul>
<a name="device(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>device</h4>
<pre>public final <a href="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</a> device(int i)
throws java.lang.IndexOutOfBoundsException</pre>
<div class="block">Returns a device from the list of devices.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - The device index.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a device from the list of devices.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if i<0 or i≥<a href="../ztex/ZtexScanBus1.html#numberOfDevices()"><code>numberOfDevices()</code></a></dd></dl>
</li>
</ul>
<a name="ref()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ref</h4>
<pre>public void ref()</pre>
<div class="block">Increases reference counter.</div>
</li>
</ul>
<a name="unref()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unref</h4>
<pre>public void unref()</pre>
<div class="block">Decreases reference counter and releases resources if 0 is reached.</div>
</li>
</ul>
<a name="finalize()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalize</h4>
<pre>protected void finalize()
throws java.lang.Throwable</pre>
<div class="block">Releases all resources.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>finalize</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Throwable</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/ZtexImgFile1.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexUsbReader.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexScanBus1.html" target="_top">Frames</a></li>
<li><a href="ZtexScanBus1.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>