nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/Flash.html

   1 <!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 <!-- Generated by javadoc (build 1.5.0_09) on Tue Jan 08 20:46:01 GMT 2008 -->
   6 <TITLE>
   7 Flash (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.Flash class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="Flash (leJOS NXT API documentation)";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  28 <!-- ========= START OF TOP NAVBAR ======= -->
  29 <A NAME="navbar_top"><!-- --></A>
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  32 <TR>
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  34 <A NAME="navbar_top_firstrow"><!-- --></A>
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  36   <TR ALIGN="center" VALIGN="top">
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  44   </TR>
  45 </TABLE>
  46 </TD>
  47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  48 </EM>
  49 </TD>
  50 </TR>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../lejos/nxt/CompassSensor.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/nxt/GyroSensor.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../index.html?lejos/nxt/Flash.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="Flash.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  59 &nbsp;<SCRIPT type="text/javascript">
  60   <!--
  61   if(window==top) {
  62     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  71 </FONT></TD>
  72 </TR>
  73 <TR>
  74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  75   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  78 </TR>
  79 </TABLE>
  80 <A NAME="skip-navbar_top"></A>
  81 <!-- ========= END OF TOP NAVBAR ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 lejos.nxt</FONT>
  88 <BR>
  89 Class Flash</H2>
  90 <PRE>
  91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
  92   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.nxt.Flash</B>
  93 </PRE>
  94 <HR>
  95 <DL>
  96 <DT><PRE>public class <B>Flash</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
  97 </PRE>
  98
  99 <P>
 100 Read and write access to flash memory in pages.
 101 <P>
 102
 103 <P>
 104 <DL>
 105 <DT><B>Author:</B></DT>
 106   <DD>Lawrie Griffiths</DD>
 107 </DL>
 108 <HR>
 109
 110 <P>
 111 <!-- =========== FIELD SUMMARY =========== -->
 112
 113 <A NAME="field_summary"><!-- --></A>
 114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 117 <B>Field Summary</B></FONT></TH>
 118 </TR>
 119 <TR BGCOLOR="white" CLASS="TableRowColor">
 120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 121 <CODE>static&nbsp;short</CODE></FONT></TD>
 122 <TD><CODE><B><A HREF="../../lejos/nxt/Flash.html#BYTES_PER_PAGE">BYTES_PER_PAGE</A></B></CODE>
 123
 124 <BR>
 125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates the # of bytes per page in a page of Flash memory.</TD>
 126 </TR>
 127 <TR BGCOLOR="white" CLASS="TableRowColor">
 128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 129 <CODE>static&nbsp;int</CODE></FONT></TD>
 130 <TD><CODE><B><A HREF="../../lejos/nxt/Flash.html#MAX_USER_PAGES">MAX_USER_PAGES</A></B></CODE>
 131
 132 <BR>
 133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maximum number of pages available to user flash memory.</TD>
 134 </TR>
 135 </TABLE>
 136 &nbsp;
 137 <!-- ========== METHOD SUMMARY =========== -->
 138
 139 <A NAME="method_summary"><!-- --></A>
 140 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 141 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 142 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 143 <B>Method Summary</B></FONT></TH>
 144 </TR>
 145 <TR BGCOLOR="white" CLASS="TableRowColor">
 146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 147 <CODE>static&nbsp;void</CODE></FONT></TD>
 148 <TD><CODE><B><A HREF="../../lejos/nxt/Flash.html#exec(int, int)">exec</A></B>(int&nbsp;pageNum,
 149      int&nbsp;size)</CODE>
 150
 151 <BR>
 152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 153 </TR>
 154 <TR BGCOLOR="white" CLASS="TableRowColor">
 155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 156 <CODE>static&nbsp;void</CODE></FONT></TD>
 157 <TD><CODE><B><A HREF="../../lejos/nxt/Flash.html#readPage(byte[], int)">readPage</A></B>(byte[]&nbsp;buf,
 158          int&nbsp;pageNum)</CODE>
 159
 160 <BR>
 161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 165 <CODE>static&nbsp;void</CODE></FONT></TD>
 166 <TD><CODE><B><A HREF="../../lejos/nxt/Flash.html#writePage(byte[], int)">writePage</A></B>(byte[]&nbsp;buf,
 167           int&nbsp;pageNum)</CODE>
 168
 169 <BR>
 170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 171 </TR>
 172 </TABLE>
 173 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 174 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 175 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 176 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
 177 </TR>
 178 <TR BGCOLOR="white" CLASS="TableRowColor">
 179 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
 180 </TR>
 181 </TABLE>
 182 &nbsp;
 183 <P>
 184
 185 <!-- ============ FIELD DETAIL =========== -->
 186
 187 <A NAME="field_detail"><!-- --></A>
 188 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 189 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 190 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 191 <B>Field Detail</B></FONT></TH>
 192 </TR>
 193 </TABLE>
 194
 195 <A NAME="MAX_USER_PAGES"><!-- --></A><H3>
 196 MAX_USER_PAGES</H3>
 197 <PRE>
 198 public static final int <B>MAX_USER_PAGES</B></PRE>
 199 <DL>
 200 <DD>Maximum number of pages available to user flash memory.
 201  Change this if the start of user flash memory in the
 202  firmware changes.
 203 <P>
 204 <DL>
 205 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Flash.MAX_USER_PAGES">Constant Field Values</A></DL>
 206 </DL>
 207 <HR>
 208
 209 <A NAME="BYTES_PER_PAGE"><!-- --></A><H3>
 210 BYTES_PER_PAGE</H3>
 211 <PRE>
 212 public static short <B>BYTES_PER_PAGE</B></PRE>
 213 <DL>
 214 <DD>Indicates the # of bytes per page in a page of Flash memory.
 215 <P>
 216 <DL>
 217 </DL>
 218 </DL>
 219
 220 <!-- ============ METHOD DETAIL ========== -->
 221
 222 <A NAME="method_detail"><!-- --></A>
 223 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 224 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 225 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 226 <B>Method Detail</B></FONT></TH>
 227 </TR>
 228 </TABLE>
 229
 230 <A NAME="readPage(byte[], int)"><!-- --></A><H3>
 231 readPage</H3>
 232 <PRE>
 233 public static void <B>readPage</B>(byte[]&nbsp;buf,
 234                             int&nbsp;pageNum)</PRE>
 235 <DL>
 236 <DD><DL>
 237 </DL>
 238 </DD>
 239 </DL>
 240 <HR>
 241
 242 <A NAME="writePage(byte[], int)"><!-- --></A><H3>
 243 writePage</H3>
 244 <PRE>
 245 public static void <B>writePage</B>(byte[]&nbsp;buf,
 246                              int&nbsp;pageNum)</PRE>
 247 <DL>
 248 <DD><DL>
 249 </DL>
 250 </DD>
 251 </DL>
 252 <HR>
 253
 254 <A NAME="exec(int, int)"><!-- --></A><H3>
 255 exec</H3>
 256 <PRE>
 257 public static void <B>exec</B>(int&nbsp;pageNum,
 258                         int&nbsp;size)</PRE>
 259 <DL>
 260 <DD><DL>
 261 </DL>
 262 </DD>
 263 </DL>
 264 <!-- ========= END OF CLASS DATA ========= -->
 265 <HR>
 266
 267
 268 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 269 <A NAME="navbar_bottom"><!-- --></A>
 270 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 271 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 272 <TR>
 273 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 274 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 275 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 276   <TR ALIGN="center" VALIGN="top">
 277   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 278   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 279   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 280   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 281   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 284   </TR>
 285 </TABLE>
 286 </TD>
 287 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 288 </EM>
 289 </TD>
 290 </TR>
 291
 292 <TR>
 293 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 294 &nbsp;<A HREF="../../lejos/nxt/CompassSensor.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
 295 &nbsp;<A HREF="../../lejos/nxt/GyroSensor.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
 296 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 297   <A HREF="../../index.html?lejos/nxt/Flash.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 298 &nbsp;<A HREF="Flash.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 299 &nbsp;<SCRIPT type="text/javascript">
 300   <!--
 301   if(window==top) {
 302     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 303   }
 304   //-->
 305 </SCRIPT>
 306 <NOSCRIPT>
 307   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 308 </NOSCRIPT>
 309
 310
 311 </FONT></TD>
 312 </TR>
 313 <TR>
 314 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 315   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 316 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 317 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 318 </TR>
 319 </TABLE>
 320 <A NAME="skip-navbar_bottom"></A>
 321 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 322
 323 <HR>
 324
 325 </BODY>
 326 </HTML>