OpenCores
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] - Blame information for rev 2

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 ZTEX 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 
<!-- NewPage -->
3 
<html lang="de">
4 
<head>
5 
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:12 CET 2017 -->
6 
<title>ImgFile</title>
7 
<meta name="date" content="2017-03-22">
8 
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
9 
</head>
10 
<body>
11 
<script type="text/javascript"><!--
12 
    if (location.href.indexOf('is-external=true') == -1) {
13 
        parent.document.title="ImgFile";
14 
    }
15 
//-->
16 
</script>
17 
<noscript>
18 
<div>JavaScript is disabled on your browser.</div>
19 
</noscript>
20 
<!-- ========= START OF TOP NAVBAR ======= -->
21 
<div class="topNav"><a name="navbar_top">
22 
<!--   -->
23 
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24 
<!--   -->
25 
</a>
26 
<ul class="navList" title="Navigation">
27 
<li><a href="../ztex/package-summary.html">Package</a></li>
28 
<li class="navBarCell1Rev">Class</li>
29 
<li><a href="package-tree.html">Tree</a></li>
30 
<li><a href="../deprecated-list.html">Deprecated</a></li>
31 
<li><a href="../index-all.html">Index</a></li>
32 
<li><a href="../help-doc.html">Help</a></li>
33 
</ul>
34 
</div>
35 
<div class="subNav">
36 
<ul class="navList">
37 
<li><a href="../ztex/Fx3Errors.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
38 
<li><a href="../ztex/ImgFileDamagedException.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
39 
</ul>
40 
<ul class="navList">
41 
<li><a href="../index.html?ztex/ImgFile.html" target="_top">Frames</a></li>
42 
<li><a href="ImgFile.html" target="_top">No Frames</a></li>
43 
</ul>
44 
<ul class="navList" id="allclasses_navbar_top">
45 
<li><a href="../allclasses-noframe.html">All Classes</a></li>
46 
</ul>
47 
<div>
48 
<script type="text/javascript"><!--
49 
  allClassesLink = document.getElementById("allclasses_navbar_top");
50 
  if(window==top) {
51 
    allClassesLink.style.display = "block";
52 
  }
53 
  else {
54 
    allClassesLink.style.display = "none";
55 
  }
56 
  //-->
57 
</script>
58 
</div>
59 
<div>
60 
<ul class="subNavList">
61 
<li>Summary:&nbsp;</li>
62 
<li>Nested&nbsp;|&nbsp;</li>
63 
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
64 
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
65 
<li><a href="#method_summary">Method</a></li>
66 
</ul>
67 
<ul class="subNavList">
68 
<li>Detail:&nbsp;</li>
69 
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
70 
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
71 
<li><a href="#method_detail">Method</a></li>
72 
</ul>
73 
</div>
74 
<a name="skip-navbar_top">
75 
<!--   -->
76 
</a></div>
77 
<!-- ========= END OF TOP NAVBAR ========= -->
78 
<!-- ======== START OF CLASS DATA ======== -->
79 
<div class="header">
80 
<div class="subTitle">ztex</div>
81 
<h2 title="Class ImgFile" class="title">Class ImgFile</h2>
82 
</div>
83 
<div class="contentContainer">
84 
<ul class="inheritance">
85 
<li>java.lang.Object</li>
86 
<li>
87 
<ul class="inheritance">
88 
<li>ztex.ImgFile</li>
89 
</ul>
90 
</li>
91 
</ul>
92 
<div class="description">
93 
<ul class="blockList">
94 
<li class="blockList">
95 
<dl>
96 
<dt>Direct Known Subclasses:</dt>
97 
<dd><a href="../ztex/ZtexImgFile1.html" title="class in ztex">ZtexImgFile1</a></dd>
98 
</dl>
99 
<hr>
100 
<br>
101 
<pre>public class <span class="strong">ImgFile</span>
102 
extends java.lang.Object</pre>
103 
<div class="block">A class representing a firmware image.</div>
104 
</li>
105 
</ul>
106 
</div>
107 
<div class="summary">
108 
<ul class="blockList">
109 
<li class="blockList">
110 
<!-- =========== FIELD SUMMARY =========== -->
111 
<ul class="blockList">
112 
<li class="blockList"><a name="field_summary">
113 
<!--   -->
114 
</a>
115 
<h3>Field Summary</h3>
116 
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
117 
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
118 
<tr>
119 
<th class="colFirst" scope="col">Modifier and Type</th>
120 
<th class="colLast" scope="col">Field and Description</th>
121 
</tr>
122 
<tr class="altColor">
123 
<td class="colFirst"><code>short[]</code></td>
124 
<td class="colLast"><code><strong><a href="../ztex/ImgFile.html#data">data</a></strong></code>
125 
<div class="block">This array stores the firmware image.</div>
126 
</td>
127 
</tr>
128 
<tr class="rowColor">
129 
<td class="colFirst"><code>boolean</code></td>
130 
<td class="colLast"><code><strong><a href="../ztex/ImgFile.html#isFx3">isFx3</a></strong></code>
131 
<div class="block">Assumed to be an FX3 firmware.</div>
132 
</td>
133 
</tr>
134 
<tr class="altColor">
135 
<td class="colFirst"><code>long</code></td>
136 
<td class="colLast"><code><strong><a href="../ztex/ImgFile.html#startVector">startVector</a></strong></code>
137 
<div class="block">Start vector.</div>
138 
</td>
139 
</tr>
140 
</table>
141 
</li>
142 
</ul>
143 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
144 
<ul class="blockList">
145 
<li class="blockList"><a name="constructor_summary">
146 
<!--   -->
147 
</a>
148 
<h3>Constructor Summary</h3>
149 
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
150 
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
151 
<tr>
152 
<th class="colOne" scope="col">Constructor and Description</th>
153 
</tr>
154 
<tr class="altColor">
155 
<td class="colOne"><code><strong><a href="../ztex/ImgFile.html#ImgFile(java.io.InputStream,%20java.lang.String)">ImgFile</a></strong>(java.io.InputStream&nbsp;in,
156 
       java.lang.String&nbsp;name)</code>
157 
<div class="block">Constructs an instance from a given file name.</div>
158 
</td>
159 
</tr>
160 
<tr class="rowColor">
161 
<td class="colOne"><code><strong><a href="../ztex/ImgFile.html#ImgFile(java.lang.String)">ImgFile</a></strong>(java.lang.String&nbsp;fileName)</code>
162 
<div class="block">Constructs an instance from a given file name.</div>
163 
</td>
164 
</tr>
165 
</table>
166 
</li>
167 
</ul>
168 
<!-- ========== METHOD SUMMARY =========== -->
169 
<ul class="blockList">
170 
<li class="blockList"><a name="method_summary">
171 
<!--   -->
172 
</a>
173 
<h3>Method Summary</h3>
174 
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
175 
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
176 
<tr>
177 
<th class="colFirst" scope="col">Modifier and Type</th>
178 
<th class="colLast" scope="col">Method and Description</th>
179 
</tr>
180 
<tr class="altColor">
181 
<td class="colFirst"><code>void</code></td>
182 
<td class="colLast"><code><strong><a href="../ztex/ImgFile.html#dataInfo(java.io.PrintStream)">dataInfo</a></strong>(java.io.PrintStream&nbsp;out)</code>
183 
<div class="block">Print out some information about the memory usage.</div>
184 
</td>
185 
</tr>
186 
<tr class="rowColor">
187 
<td class="colFirst"><code>static long</code></td>
188 
<td class="colLast"><code><strong><a href="../ztex/ImgFile.html#uncompressAddr(int)">uncompressAddr</a></strong>(int&nbsp;addr)</code>
189 
<div class="block">Uncompresses the FX3 address space.</div>
190 
</td>
191 
</tr>
192 
</table>
193 
<ul class="blockList">
194 
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
195 
<!--   -->
196 
</a>
197 
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
198 
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
199 
</ul>
200 
</li>
201 
</ul>
202 
</li>
203 
</ul>
204 
</div>
205 
<div class="details">
206 
<ul class="blockList">
207 
<li class="blockList">
208 
<!-- ============ FIELD DETAIL =========== -->
209 
<ul class="blockList">
210 
<li class="blockList"><a name="field_detail">
211 
<!--   -->
212 
</a>
213 
<h3>Field Detail</h3>
214 
<a name="data">
215 
<!--   -->
216 
</a>
217 
<ul class="blockList">
218 
<li class="blockList">
219 
<h4>data</h4>
220 
<pre>public&nbsp;short[] data</pre>
221 
<div class="block">This array stores the firmware image.
222 
 Values &lt;0 and &gt;255 mean that the data is undefined.</div>
223 
</li>
224 
</ul>
225 
<a name="startVector">
226 
<!--   -->
227 
</a>
228 
<ul class="blockList">
229 
<li class="blockList">
230 
<h4>startVector</h4>
231 
<pre>public&nbsp;long startVector</pre>
232 
<div class="block">Start vector.
233 
 Values &lt;0 mean that no start vector is defined.</div>
234 
</li>
235 
</ul>
236 
<a name="isFx3">
237 
<!--   -->
238 
</a>
239 
<ul class="blockListLast">
240 
<li class="blockList">
241 
<h4>isFx3</h4>
242 
<pre>public&nbsp;boolean isFx3</pre>
243 
<div class="block">Assumed to be an FX3 firmware.
244 
 This value is also set by <a href="../ztex/ZtexImgFile1.html" title="class in ztex"><code>ZtexImgFile1</code></a>.</div>
245 
</li>
246 
</ul>
247 
</li>
248 
</ul>
249 
<!-- ========= CONSTRUCTOR DETAIL ======== -->
250 
<ul class="blockList">
251 
<li class="blockList"><a name="constructor_detail">
252 
<!--   -->
253 
</a>
254 
<h3>Constructor Detail</h3>
255 
<a name="ImgFile(java.io.InputStream, java.lang.String)">
256 
<!--   -->
257 
</a>
258 
<ul class="blockList">
259 
<li class="blockList">
260 
<h4>ImgFile</h4>
261 
<pre>public&nbsp;ImgFile(java.io.InputStream&nbsp;in,
262 
       java.lang.String&nbsp;name)
263 
        throws java.io.IOException,
264 
               <a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></pre>
265 
<div class="block">Constructs an instance from a given file name.
266 
 This method can also read system resources, e.g. files from the current jar archive.</div>
267 
<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>
268 
<dt><span class="strong">Throws:</span></dt>
269 
<dd><code>java.io.IOException</code> - If an read error occurred.</dd>
270 
<dd><code><a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></code> - If the firmware file is damaged.</dd></dl>
271 
</li>
272 
</ul>
273 
<a name="ImgFile(java.lang.String)">
274 
<!--   -->
275 
</a>
276 
<ul class="blockListLast">
277 
<li class="blockList">
278 
<h4>ImgFile</h4>
279 
<pre>public&nbsp;ImgFile(java.lang.String&nbsp;fileName)
280 
        throws java.io.IOException,
281 
               <a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></pre>
282 
<div class="block">Constructs an instance from a given file name.
283 
 This method can also read system resources, e.g. files from the current jar archive.</div>
284 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - The file name.</dd>
285 
<dt><span class="strong">Throws:</span></dt>
286 
<dd><code>java.io.IOException</code> - If an read error occurred.</dd>
287 
<dd><code><a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></code> - If the firmware image file is damaged.</dd></dl>
288 
</li>
289 
</ul>
290 
</li>
291 
</ul>
292 
<!-- ============ METHOD DETAIL ========== -->
293 
<ul class="blockList">
294 
<li class="blockList"><a name="method_detail">
295 
<!--   -->
296 
</a>
297 
<h3>Method Detail</h3>
298 
<a name="uncompressAddr(int)">
299 
<!--   -->
300 
</a>
301 
<ul class="blockList">
302 
<li class="blockList">
303 
<h4>uncompressAddr</h4>
304 
<pre>public static final&nbsp;long&nbsp;uncompressAddr(int&nbsp;addr)</pre>
305 
<div class="block">Uncompresses the FX3 address space.</div>
306 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>addr</code> - Compressed address</dd>
307 
<dt><span class="strong">Returns:</span></dt><dd>Uncompressed address.</dd></dl>
308 
</li>
309 
</ul>
310 
<a name="dataInfo(java.io.PrintStream)">
311 
<!--   -->
312 
</a>
313 
<ul class="blockListLast">
314 
<li class="blockList">
315 
<h4>dataInfo</h4>
316 
<pre>public&nbsp;void&nbsp;dataInfo(java.io.PrintStream&nbsp;out)</pre>
317 
<div class="block">Print out some information about the memory usage.</div>
318 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - Where the data is printed out.</dd></dl>
319 
</li>
320 
</ul>
321 
</li>
322 
</ul>
323 
</li>
324 
</ul>
325 
</div>
326 
</div>
327 
<!-- ========= END OF CLASS DATA ========= -->
328 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
329 
<div class="bottomNav"><a name="navbar_bottom">
330 
<!--   -->
331 
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
332 
<!--   -->
333 
</a>
334 
<ul class="navList" title="Navigation">
335 
<li><a href="../ztex/package-summary.html">Package</a></li>
336 
<li class="navBarCell1Rev">Class</li>
337 
<li><a href="package-tree.html">Tree</a></li>
338 
<li><a href="../deprecated-list.html">Deprecated</a></li>
339 
<li><a href="../index-all.html">Index</a></li>
340 
<li><a href="../help-doc.html">Help</a></li>
341 
</ul>
342 
</div>
343 
<div class="subNav">
344 
<ul class="navList">
345 
<li><a href="../ztex/Fx3Errors.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
346 
<li><a href="../ztex/ImgFileDamagedException.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
347 
</ul>
348 
<ul class="navList">
349 
<li><a href="../index.html?ztex/ImgFile.html" target="_top">Frames</a></li>
350 
<li><a href="ImgFile.html" target="_top">No Frames</a></li>
351 
</ul>
352 
<ul class="navList" id="allclasses_navbar_bottom">
353 
<li><a href="../allclasses-noframe.html">All Classes</a></li>
354 
</ul>
355 
<div>
356 
<script type="text/javascript"><!--
357 
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
358 
  if(window==top) {
359 
    allClassesLink.style.display = "block";
360 
  }
361 
  else {
362 
    allClassesLink.style.display = "none";
363 
  }
364 
  //-->
365 
</script>
366 
</div>
367 
<div>
368 
<ul class="subNavList">
369 
<li>Summary:&nbsp;</li>
370 
<li>Nested&nbsp;|&nbsp;</li>
371 
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
372 
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
373 
<li><a href="#method_summary">Method</a></li>
374 
</ul>
375 
<ul class="subNavList">
376 
<li>Detail:&nbsp;</li>
377 
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
378 
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
379 
<li><a href="#method_detail">Method</a></li>
380 
</ul>
381 
</div>
382 
<a name="skip-navbar_bottom">
383 
<!--   -->
384 
</a></div>
385 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
386 
</body>
387 
</html>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.