OpenCores
URL https://opencores.org/ocsvn/usb_fpga_1_15/usb_fpga_1_15/trunk

Subversion Repositories usb_fpga_1_15

[/] [usb_fpga_1_15/] [trunk/] [docs/] [java/] [ztex/] [ZtexIhxFile1.html] - Blame information for rev 3

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>
4
<HEAD>
5 3 ZTEX
<!-- Generated by javadoc (build 1.6.0_18) on Wed Oct 30 21:18:13 CET 2013 -->
6 2 ZTEX
<TITLE>
7
ZtexIhxFile1
8
</TITLE>
9
 
10 3 ZTEX
<META NAME="date" CONTENT="2013-10-30">
11 2 ZTEX
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
13
 
14
<SCRIPT type="text/javascript">
15
function windowTitle()
16
{
17
    if (location.href.indexOf('is-external=true') == -1) {
18
        parent.document.title="ZtexIhxFile1";
19
    }
20
}
21
</SCRIPT>
22
<NOSCRIPT>
23
</NOSCRIPT>
24
 
25
</HEAD>
26
 
27
<BODY BGCOLOR="white" onload="windowTitle();">
28
<HR>
29
 
30
 
31
<!-- ========= START OF TOP NAVBAR ======= -->
32
<A NAME="navbar_top"><!-- --></A>
33
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35
<TR>
36
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37
<A NAME="navbar_top_firstrow"><!-- --></A>
38
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39
  <TR ALIGN="center" VALIGN="top">
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47
  </TR>
48
</TABLE>
49
</TD>
50
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51
</EM>
52
</TD>
53
</TR>
54
 
55
<TR>
56
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57
&nbsp;<A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><B>PREV CLASS</B></A>&nbsp;
58
&nbsp;<A HREF="../ztex/ZtexScanBus1.html" title="class in ztex"><B>NEXT CLASS</B></A></FONT></TD>
59
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60
  <A HREF="../index.html?ztex/ZtexIhxFile1.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61
&nbsp;<A HREF="ZtexIhxFile1.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62
&nbsp;<SCRIPT type="text/javascript">
63
  <!--
64
  if(window==top) {
65
    document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
66
  }
67
  //-->
68
</SCRIPT>
69
<NOSCRIPT>
70
  <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
71
</NOSCRIPT>
72
 
73
 
74
</FONT></TD>
75
</TR>
76
<TR>
77
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_ztex.IhxFile">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81
</TR>
82
</TABLE>
83
<A NAME="skip-navbar_top"></A>
84
<!-- ========= END OF TOP NAVBAR ========= -->
85
 
86
<HR>
87
<!-- ======== START OF CLASS DATA ======== -->
88
<H2>
89
<FONT SIZE="-1">
90
ztex</FONT>
91
<BR>
92
Class ZtexIhxFile1</H2>
93
<PRE>
94
java.lang.Object
95
  <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../ztex/IhxFile.html" title="class in ztex">ztex.IhxFile</A>
96
      <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>ztex.ZtexIhxFile1</B>
97
</PRE>
98
<HR>
99
<DL>
100
<DT><PRE>public class <B>ZtexIhxFile1</B><DT>extends <A HREF="../ztex/IhxFile.html" title="class in ztex">IhxFile</A></DL>
101
</PRE>
102
 
103
<P>
104
Represents a firmware image with ZTEX descriptor 1 loaded from an ihx (Intel Hex format) file. <br>
105
 The ZTEX descriptor is usually located at the position 0x6x of the firmware image. <br>
106
 A description of the ZTEX descriptor 1 can be found in <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.
107
<P>
108
 
109
<P>
110
<DL>
111
<DT><B>See Also:</B><DD><A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>,
112
<A HREF="../ztex/Ztex1.html" title="class in ztex"><CODE>Ztex1</CODE></A></DL>
113
<HR>
114
 
115
<P>
116
<!-- =========== FIELD SUMMARY =========== -->
117
 
118
<A NAME="field_summary"><!-- --></A>
119
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
122
<B>Field Summary</B></FONT></TH>
123
</TR>
124
</TABLE>
125
&nbsp;<A NAME="fields_inherited_from_class_ztex.IhxFile"><!-- --></A>
126
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
128
<TH ALIGN="left"><B>Fields inherited from class ztex.<A HREF="../ztex/IhxFile.html" title="class in ztex">IhxFile</A></B></TH>
129
</TR>
130
<TR BGCOLOR="white" CLASS="TableRowColor">
131
<TD><CODE><A HREF="../ztex/IhxFile.html#ihxData">ihxData</A></CODE></TD>
132
</TR>
133
</TABLE>
134
&nbsp;
135
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
136
 
137
<A NAME="constructor_summary"><!-- --></A>
138
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141
<B>Constructor Summary</B></FONT></TH>
142
</TR>
143
<TR BGCOLOR="white" CLASS="TableRowColor">
144 3 ZTEX
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#ZtexIhxFile1(java.io.InputStream, java.lang.String)">ZtexIhxFile1</A></B>(java.io.InputStream&nbsp;in,
145
             java.lang.String&nbsp;name)</CODE>
146
 
147
<BR>
148
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an instance from a given file name and descriptor position.</TD>
149
</TR>
150
<TR BGCOLOR="white" CLASS="TableRowColor">
151
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#ZtexIhxFile1(java.io.InputStream, java.lang.String, int)">ZtexIhxFile1</A></B>(java.io.InputStream&nbsp;in,
152
             java.lang.String&nbsp;name,
153
             int&nbsp;pZtexDescriptorOffs)</CODE>
154
 
155
<BR>
156
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an instance from a given file name and descriptor position.</TD>
157
</TR>
158
<TR BGCOLOR="white" CLASS="TableRowColor">
159 2 ZTEX
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#ZtexIhxFile1(java.lang.String)">ZtexIhxFile1</A></B>(java.lang.String&nbsp;fileName)</CODE>
160
 
161
<BR>
162
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an instance from a given file name.</TD>
163
</TR>
164
<TR BGCOLOR="white" CLASS="TableRowColor">
165
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#ZtexIhxFile1(java.lang.String, int)">ZtexIhxFile1</A></B>(java.lang.String&nbsp;fileName,
166
             int&nbsp;pZtexDescriptorOffs)</CODE>
167
 
168
<BR>
169
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an instance from a given file name and descriptor position.</TD>
170
</TR>
171
</TABLE>
172
&nbsp;
173
<!-- ========== METHOD SUMMARY =========== -->
174
 
175
<A NAME="method_summary"><!-- --></A>
176
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
178
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
179
<B>Method Summary</B></FONT></TH>
180
</TR>
181
<TR BGCOLOR="white" CLASS="TableRowColor">
182
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183
<CODE>&nbsp;int</CODE></FONT></TD>
184
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#fwVersion()">fwVersion</A></B>()</CODE>
185
 
186
<BR>
187
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the firmware version.</TD>
188
</TR>
189
<TR BGCOLOR="white" CLASS="TableRowColor">
190
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191
<CODE>&nbsp;byte[]</CODE></FONT></TD>
192
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#interfaceCapabilities()">interfaceCapabilities</A></B>()</CODE>
193
 
194
<BR>
195
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the interface capabilities (all 6 bytes).</TD>
196
</TR>
197
<TR BGCOLOR="white" CLASS="TableRowColor">
198
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199
<CODE>&nbsp;int</CODE></FONT></TD>
200
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#interfaceCapabilities(int)">interfaceCapabilities</A></B>(int&nbsp;i)</CODE>
201
 
202
<BR>
203
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns byte i of the interface capabilities.</TD>
204
</TR>
205
<TR BGCOLOR="white" CLASS="TableRowColor">
206
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207
<CODE>&nbsp;int</CODE></FONT></TD>
208
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#interfaceVersion()">interfaceVersion</A></B>()</CODE>
209
 
210
<BR>
211
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the interface version.</TD>
212
</TR>
213
<TR BGCOLOR="white" CLASS="TableRowColor">
214
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215
<CODE>&nbsp;byte[]</CODE></FONT></TD>
216
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#moduleReserved()">moduleReserved</A></B>()</CODE>
217
 
218
<BR>
219
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the application specific information (all 12 bytes).</TD>
220
</TR>
221
<TR BGCOLOR="white" CLASS="TableRowColor">
222
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223
<CODE>&nbsp;int</CODE></FONT></TD>
224
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#moduleReserved(int)">moduleReserved</A></B>(int&nbsp;i)</CODE>
225
 
226
<BR>
227
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns byte i of the application specific information.</TD>
228
</TR>
229
<TR BGCOLOR="white" CLASS="TableRowColor">
230
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231
<CODE>&nbsp;byte[]</CODE></FONT></TD>
232
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#productId()">productId</A></B>()</CODE>
233
 
234
<BR>
235
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the product ID (all 4 bytes).</TD>
236
</TR>
237
<TR BGCOLOR="white" CLASS="TableRowColor">
238
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239
<CODE>&nbsp;int</CODE></FONT></TD>
240
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#productId(int)">productId</A></B>(int&nbsp;i)</CODE>
241
 
242
<BR>
243
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns byte i of the product ID.</TD>
244
</TR>
245
<TR BGCOLOR="white" CLASS="TableRowColor">
246
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247
<CODE>&nbsp;void</CODE></FONT></TD>
248
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#setSnString(java.lang.String)">setSnString</A></B>(java.lang.String&nbsp;s)</CODE>
249
 
250
<BR>
251
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Modifies the serial number string.</TD>
252
</TR>
253
<TR BGCOLOR="white" CLASS="TableRowColor">
254
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
256
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#snString()">snString</A></B>()</CODE>
257
 
258
<BR>
259
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the serial number string.</TD>
260
</TR>
261
<TR BGCOLOR="white" CLASS="TableRowColor">
262
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
264
<TD><CODE><B><A HREF="../ztex/ZtexIhxFile1.html#toString()">toString</A></B>()</CODE>
265
 
266
<BR>
267
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation if the instance.</TD>
268
</TR>
269
</TABLE>
270
&nbsp;<A NAME="methods_inherited_from_class_ztex.IhxFile"><!-- --></A>
271
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
272
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
273
<TH ALIGN="left"><B>Methods inherited from class ztex.<A HREF="../ztex/IhxFile.html" title="class in ztex">IhxFile</A></B></TH>
274
</TR>
275
<TR BGCOLOR="white" CLASS="TableRowColor">
276
<TD><CODE><A HREF="../ztex/IhxFile.html#dataInfo(java.io.PrintStream)">dataInfo</A></CODE></TD>
277
</TR>
278
</TABLE>
279
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
280
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
281
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
282
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
283
</TR>
284
<TR BGCOLOR="white" CLASS="TableRowColor">
285
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
286
</TR>
287
</TABLE>
288
&nbsp;
289
<P>
290
 
291
<!-- ========= CONSTRUCTOR DETAIL ======== -->
292
 
293
<A NAME="constructor_detail"><!-- --></A>
294
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
295
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
296
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
297
<B>Constructor Detail</B></FONT></TH>
298
</TR>
299
</TABLE>
300
 
301 3 ZTEX
<A NAME="ZtexIhxFile1(java.io.InputStream, java.lang.String, int)"><!-- --></A><H3>
302
ZtexIhxFile1</H3>
303
<PRE>
304
public <B>ZtexIhxFile1</B>(java.io.InputStream&nbsp;in,
305
                    java.lang.String&nbsp;name,
306
                    int&nbsp;pZtexDescriptorOffs)
307
             throws java.io.IOException,
308
                    <A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A>,
309
                    <A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></PRE>
310
<DL>
311
<DD>Constructs an instance from a given file name and descriptor position.<br>
312
 This method can also read system resources, e.g. files from the current jar archive.
313
<P>
314
<DL>
315
<DT><B>Parameters:</B><DD><CODE>in</CODE> - Input stream from which the ihx file is read.<DD><CODE>name</CODE> - Name of the input.<DD><CODE>pZtexDescriptorOffs</CODE> - The position of the descriptor in bytes. The default position is 0x6c.
316
<DT><B>Throws:</B>
317
<DD><CODE>java.io.IOException</CODE> - If an read error occurred.
318
<DD><CODE><A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A></CODE> - If the ihx file is damaged.
319
<DD><CODE><A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></CODE> - If the firmware image contains no valid ZTEX descriptor 1 at the specified position.</DL>
320
</DL>
321
<HR>
322
 
323
<A NAME="ZtexIhxFile1(java.io.InputStream, java.lang.String)"><!-- --></A><H3>
324
ZtexIhxFile1</H3>
325
<PRE>
326
public <B>ZtexIhxFile1</B>(java.io.InputStream&nbsp;in,
327
                    java.lang.String&nbsp;name)
328
             throws java.io.IOException,
329
                    <A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A>,
330
                    <A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></PRE>
331
<DL>
332
<DD>Constructs an instance from a given file name and descriptor position.<br>
333
 The ZTEX descriptor 1 is expected to be at the position 0x6c of the firmware image.<br>
334
 This method can also read system resources, e.g. files from the current jar archive.
335
<P>
336
<DL>
337
<DT><B>Parameters:</B><DD><CODE>in</CODE> - Input stream from which the ihx file is read.<DD><CODE>name</CODE> - Name of the input.
338
<DT><B>Throws:</B>
339
<DD><CODE>java.io.IOException</CODE> - If an read error occurred.
340
<DD><CODE><A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A></CODE> - If the ihx file is damaged.
341
<DD><CODE><A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></CODE> - If the firmware image contains no valid ZTEX descriptor 1 at the specified position.</DL>
342
</DL>
343
<HR>
344
 
345 2 ZTEX
<A NAME="ZtexIhxFile1(java.lang.String, int)"><!-- --></A><H3>
346
ZtexIhxFile1</H3>
347
<PRE>
348
public <B>ZtexIhxFile1</B>(java.lang.String&nbsp;fileName,
349
                    int&nbsp;pZtexDescriptorOffs)
350
             throws java.io.IOException,
351
                    <A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A>,
352
                    <A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></PRE>
353
<DL>
354
<DD>Constructs an instance from a given file name and descriptor position.<br>
355
 This method can also read system resources, e.g. files from the current jar archive.
356
<P>
357
<DL>
358
<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The file name.<DD><CODE>pZtexDescriptorOffs</CODE> - The position of the descriptor in bytes. The default position is 0x6c.
359
<DT><B>Throws:</B>
360
<DD><CODE>java.io.IOException</CODE> - If an read error occurred.
361
<DD><CODE><A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A></CODE> - If the ihx file is damaged.
362
<DD><CODE><A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></CODE> - If the firmware image contains no valid ZTEX descriptor 1 at the specified position.</DL>
363
</DL>
364
<HR>
365
 
366
<A NAME="ZtexIhxFile1(java.lang.String)"><!-- --></A><H3>
367
ZtexIhxFile1</H3>
368
<PRE>
369
public <B>ZtexIhxFile1</B>(java.lang.String&nbsp;fileName)
370
             throws java.io.IOException,
371
                    <A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A>,
372
                    <A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></PRE>
373
<DL>
374
<DD>Constructs an instance from a given file name.
375
 The ZTEX descriptor 1 is expected to be at the position 0x6c of the firmware image.<br>
376
 This method can also read system resources, e.g. files from the current jar archive.
377
<P>
378
<DL>
379
<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The file name.
380
<DT><B>Throws:</B>
381
<DD><CODE>java.io.IOException</CODE> - If an read error occurred.
382
<DD><CODE><A HREF="../ztex/IhxFileDamagedException.html" title="class in ztex">IhxFileDamagedException</A></CODE> - If the ihx file is damaged.
383
<DD><CODE><A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></CODE> - If the firmware image contains no valid ZTEX descriptor 1 at the specified position.</DL>
384
</DL>
385
 
386
<!-- ============ METHOD DETAIL ========== -->
387
 
388
<A NAME="method_detail"><!-- --></A>
389
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
390
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
391
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
392
<B>Method Detail</B></FONT></TH>
393
</TR>
394
</TABLE>
395
 
396
<A NAME="productId()"><!-- --></A><H3>
397
productId</H3>
398
<PRE>
399
public final byte[] <B>productId</B>()</PRE>
400
<DL>
401
<DD>Returns the product ID (all 4 bytes).
402
<P>
403
<DD><DL>
404
 
405
<DT><B>Returns:</B><DD>PRODUCT_ID, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
406
</DD>
407
</DL>
408
<HR>
409
 
410
<A NAME="productId(int)"><!-- --></A><H3>
411
productId</H3>
412
<PRE>
413
public int <B>productId</B>(int&nbsp;i)</PRE>
414
<DL>
415
<DD>Returns byte i of the product ID.
416
<P>
417
<DD><DL>
418
<DT><B>Parameters:</B><DD><CODE>i</CODE> - index
419
<DT><B>Returns:</B><DD>PRODUCT_ID[i], see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
420
</DD>
421
</DL>
422
<HR>
423
 
424
<A NAME="fwVersion()"><!-- --></A><H3>
425
fwVersion</H3>
426
<PRE>
427
public final int <B>fwVersion</B>()</PRE>
428
<DL>
429
<DD>Returns the firmware version.
430
<P>
431
<DD><DL>
432
 
433
<DT><B>Returns:</B><DD>FW_VERSION, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
434
</DD>
435
</DL>
436
<HR>
437
 
438
<A NAME="interfaceVersion()"><!-- --></A><H3>
439
interfaceVersion</H3>
440
<PRE>
441
public final int <B>interfaceVersion</B>()</PRE>
442
<DL>
443
<DD>Returns the interface version.
444
<P>
445
<DD><DL>
446
 
447
<DT><B>Returns:</B><DD>INTERFACE_VERSION, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
448
</DD>
449
</DL>
450
<HR>
451
 
452
<A NAME="interfaceCapabilities()"><!-- --></A><H3>
453
interfaceCapabilities</H3>
454
<PRE>
455
public final byte[] <B>interfaceCapabilities</B>()</PRE>
456
<DL>
457
<DD>Returns the interface capabilities (all 6 bytes).
458
<P>
459
<DD><DL>
460
 
461
<DT><B>Returns:</B><DD>INTERFACE_CAPABILITIES, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
462
</DD>
463
</DL>
464
<HR>
465
 
466
<A NAME="interfaceCapabilities(int)"><!-- --></A><H3>
467
interfaceCapabilities</H3>
468
<PRE>
469
public final int <B>interfaceCapabilities</B>(int&nbsp;i)</PRE>
470
<DL>
471
<DD>Returns byte i of the interface capabilities.
472
<P>
473
<DD><DL>
474
<DT><B>Parameters:</B><DD><CODE>i</CODE> - index
475
<DT><B>Returns:</B><DD>INTERFACE_CAPABILITIES[i], see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
476
</DD>
477
</DL>
478
<HR>
479
 
480
<A NAME="moduleReserved()"><!-- --></A><H3>
481
moduleReserved</H3>
482
<PRE>
483
public final byte[] <B>moduleReserved</B>()</PRE>
484
<DL>
485
<DD>Returns the application specific information (all 12 bytes).
486
<P>
487
<DD><DL>
488
 
489
<DT><B>Returns:</B><DD>MODULE_RESERVED, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
490
</DD>
491
</DL>
492
<HR>
493
 
494
<A NAME="moduleReserved(int)"><!-- --></A><H3>
495
moduleReserved</H3>
496
<PRE>
497
public final int <B>moduleReserved</B>(int&nbsp;i)</PRE>
498
<DL>
499
<DD>Returns byte i of the application specific information.
500
<P>
501
<DD><DL>
502
<DT><B>Parameters:</B><DD><CODE>i</CODE> - index
503
<DT><B>Returns:</B><DD>MODULE_RESERVED[i], see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
504
</DD>
505
</DL>
506
<HR>
507
 
508
<A NAME="snString()"><!-- --></A><H3>
509
snString</H3>
510
<PRE>
511
public final java.lang.String <B>snString</B>()</PRE>
512
<DL>
513
<DD>Returns the serial number string.
514
<P>
515
<DD><DL>
516
 
517
<DT><B>Returns:</B><DD>SN_STRING, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.</DL>
518
</DD>
519
</DL>
520
<HR>
521
 
522
<A NAME="setSnString(java.lang.String)"><!-- --></A><H3>
523
setSnString</H3>
524
<PRE>
525
public final void <B>setSnString</B>(java.lang.String&nbsp;s)
526
                       throws <A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></PRE>
527
<DL>
528
<DD>Modifies the serial number string.
529
<P>
530
<DD><DL>
531
<DT><B>Parameters:</B><DD><CODE>s</CODE> - The new serial number string which must not be longer then 10 characters.
532
<DT><B>Throws:</B>
533
<DD><CODE><A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></CODE></DL>
534
</DD>
535
</DL>
536
<HR>
537
 
538
<A NAME="toString()"><!-- --></A><H3>
539
toString</H3>
540
<PRE>
541
public java.lang.String <B>toString</B>()</PRE>
542
<DL>
543
<DD>Returns a string representation if the instance.
544
<P>
545
<DD><DL>
546
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
547
</DD>
548
<DD><DL>
549
 
550
<DT><B>Returns:</B><DD>a string representation if the instance.</DL>
551
</DD>
552
</DL>
553
<!-- ========= END OF CLASS DATA ========= -->
554
<HR>
555
 
556
 
557
<!-- ======= START OF BOTTOM NAVBAR ====== -->
558
<A NAME="navbar_bottom"><!-- --></A>
559
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
560
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
561
<TR>
562
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
563
<A NAME="navbar_bottom_firstrow"><!-- --></A>
564
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
565
  <TR ALIGN="center" VALIGN="top">
566
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
567
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
568
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
569
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
570
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
571
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
572
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
573
  </TR>
574
</TABLE>
575
</TD>
576
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
577
</EM>
578
</TD>
579
</TR>
580
 
581
<TR>
582
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
583
&nbsp;<A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><B>PREV CLASS</B></A>&nbsp;
584
&nbsp;<A HREF="../ztex/ZtexScanBus1.html" title="class in ztex"><B>NEXT CLASS</B></A></FONT></TD>
585
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
586
  <A HREF="../index.html?ztex/ZtexIhxFile1.html" target="_top"><B>FRAMES</B></A>  &nbsp;
587
&nbsp;<A HREF="ZtexIhxFile1.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
588
&nbsp;<SCRIPT type="text/javascript">
589
  <!--
590
  if(window==top) {
591
    document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
592
  }
593
  //-->
594
</SCRIPT>
595
<NOSCRIPT>
596
  <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
597
</NOSCRIPT>
598
 
599
 
600
</FONT></TD>
601
</TR>
602
<TR>
603
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
604
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_ztex.IhxFile">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
605
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
606
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
607
</TR>
608
</TABLE>
609
<A NAME="skip-navbar_bottom"></A>
610
<!-- ======== END OF BOTTOM NAVBAR ======= -->
611
 
612
<HR>
613
 
614
</BODY>
615
</HTML>

powered by: WebSVN 2.1.0

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