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/] [ImgFile.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:12 CET 2017 --> <title>ImgFile</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="ImgFile"; } //--> </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/Fx3Errors.html" title="class in ztex"><span class="strong">Prev Class</span></a></li> <li><a href="../ztex/ImgFileDamagedException.html" title="class in ztex"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?ztex/ImgFile.html" target="_top">Frames</a></li> <li><a href="ImgFile.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 ImgFile" class="title">Class ImgFile</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>ztex.ImgFile</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../ztex/ZtexImgFile1.html" title="class in ztex">ZtexImgFile1</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">ImgFile</span> extends java.lang.Object</pre> <div class="block">A class representing a firmware image.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>short[]</code></td> <td class="colLast"><code><strong><a href="../ztex/ImgFile.html#data">data</a></strong></code> <div class="block">This array stores the firmware image.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../ztex/ImgFile.html#isFx3">isFx3</a></strong></code> <div class="block">Assumed to be an FX3 firmware.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../ztex/ImgFile.html#startVector">startVector</a></strong></code> <div class="block">Start vector.</div> </td> </tr> </table> </li> </ul> <!-- ======== 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/ImgFile.html#ImgFile(java.io.InputStream,%20java.lang.String)">ImgFile</a></strong>(java.io.InputStream in, java.lang.String name)</code> <div class="block">Constructs an instance from a given file name.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../ztex/ImgFile.html#ImgFile(java.lang.String)">ImgFile</a></strong>(java.lang.String fileName)</code> <div class="block">Constructs an instance from a given file name.</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>void</code></td> <td class="colLast"><code><strong><a href="../ztex/ImgFile.html#dataInfo(java.io.PrintStream)">dataInfo</a></strong>(java.io.PrintStream out)</code> <div class="block">Print out some information about the memory usage.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../ztex/ImgFile.html#uncompressAddr(int)">uncompressAddr</a></strong>(int addr)</code> <div class="block">Uncompresses the FX3 address space.</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, finalize, 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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="data"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>data</h4> <pre>public short[] data</pre> <div class="block">This array stores the firmware image. Values <0 and >255 mean that the data is undefined.</div> </li> </ul> <a name="startVector"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>startVector</h4> <pre>public long startVector</pre> <div class="block">Start vector. Values <0 mean that no start vector is defined.</div> </li> </ul> <a name="isFx3"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>isFx3</h4> <pre>public boolean isFx3</pre> <div class="block">Assumed to be an FX3 firmware. This value is also set by <a href="../ztex/ZtexImgFile1.html" title="class in ztex"><code>ZtexImgFile1</code></a>.</div> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="ImgFile(java.io.InputStream, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ImgFile</h4> <pre>public ImgFile(java.io.InputStream in, java.lang.String name) throws java.io.IOException, <a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></pre> <div class="block">Constructs an instance from a given file name. This method can also read system resources, e.g. files from the current jar archive.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - Input stream from which the firmware file is read.</dd><dd><code>name</code> - Name of the input.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code> - If an read error occurred.</dd> <dd><code><a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></code> - If the firmware file is damaged.</dd></dl> </li> </ul> <a name="ImgFile(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ImgFile</h4> <pre>public ImgFile(java.lang.String fileName) throws java.io.IOException, <a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></pre> <div class="block">Constructs an instance from a given file name. This method can also read system resources, e.g. files from the current jar archive.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - The file name.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code> - If an read error occurred.</dd> <dd><code><a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></code> - If the firmware image file is damaged.</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="uncompressAddr(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>uncompressAddr</h4> <pre>public static final long uncompressAddr(int addr)</pre> <div class="block">Uncompresses the FX3 address space.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>addr</code> - Compressed address</dd> <dt><span class="strong">Returns:</span></dt><dd>Uncompressed address.</dd></dl> </li> </ul> <a name="dataInfo(java.io.PrintStream)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>dataInfo</h4> <pre>public void dataInfo(java.io.PrintStream out)</pre> <div class="block">Print out some information about the memory usage.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - Where the data is printed out.</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/Fx3Errors.html" title="class in ztex"><span class="strong">Prev Class</span></a></li> <li><a href="../ztex/ImgFileDamagedException.html" title="class in ztex"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?ztex/ImgFile.html" target="_top">Frames</a></li> <li><a href="ImgFile.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>