nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/Poll.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 Poll (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.Poll 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="Poll (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/NXTCam.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/nxt/RCXLightSensor.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/Poll.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="Poll.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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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 Poll</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.Poll</B>
  93 </PRE>
  94 <HR>
  95 <DL>
  96 <DT><PRE>public class <B>Poll</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
  97 </PRE>
  98
  99 <P>
 100 Provides blocking access to events from the NXT. Poll is a bit
 101  of a misnomer (since you don't 'poll' at all) but it takes its
 102  name from the Unix call of the same name.
 103 <P>
 104
 105 <P>
 106 <HR>
 107
 108 <P>
 109 <!-- =========== FIELD SUMMARY =========== -->
 110
 111 <A NAME="field_summary"><!-- --></A>
 112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 114 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 115 <B>Field Summary</B></FONT></TH>
 116 </TR>
 117 <TR BGCOLOR="white" CLASS="TableRowColor">
 118 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 119 <CODE>static&nbsp;short</CODE></FONT></TD>
 120 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#ALL_BUTTONS">ALL_BUTTONS</A></B></CODE>
 121
 122 <BR>
 123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 124 </TR>
 125 <TR BGCOLOR="white" CLASS="TableRowColor">
 126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 127 <CODE>static&nbsp;short</CODE></FONT></TD>
 128 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#ALL_SENSORS">ALL_SENSORS</A></B></CODE>
 129
 130 <BR>
 131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 132 </TR>
 133 <TR BGCOLOR="white" CLASS="TableRowColor">
 134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 135 <CODE>static&nbsp;short</CODE></FONT></TD>
 136 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#BUTTON_MASK_SHIFT">BUTTON_MASK_SHIFT</A></B></CODE>
 137
 138 <BR>
 139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 140 </TR>
 141 <TR BGCOLOR="white" CLASS="TableRowColor">
 142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 143 <CODE>static&nbsp;short</CODE></FONT></TD>
 144 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#ENTER_MASK">ENTER_MASK</A></B></CODE>
 145
 146 <BR>
 147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 148 </TR>
 149 <TR BGCOLOR="white" CLASS="TableRowColor">
 150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 151 <CODE>static&nbsp;short</CODE></FONT></TD>
 152 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#ESCAPE_MASK">ESCAPE_MASK</A></B></CODE>
 153
 154 <BR>
 155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 156 </TR>
 157 <TR BGCOLOR="white" CLASS="TableRowColor">
 158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 159 <CODE>static&nbsp;short</CODE></FONT></TD>
 160 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#LEFT_MASK">LEFT_MASK</A></B></CODE>
 161
 162 <BR>
 163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 164 </TR>
 165 <TR BGCOLOR="white" CLASS="TableRowColor">
 166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 167 <CODE>static&nbsp;short</CODE></FONT></TD>
 168 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#RIGHT_MASK">RIGHT_MASK</A></B></CODE>
 169
 170 <BR>
 171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 172 </TR>
 173 <TR BGCOLOR="white" CLASS="TableRowColor">
 174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 175 <CODE>static&nbsp;short</CODE></FONT></TD>
 176 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#SENSOR1_MASK">SENSOR1_MASK</A></B></CODE>
 177
 178 <BR>
 179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 180 </TR>
 181 <TR BGCOLOR="white" CLASS="TableRowColor">
 182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 183 <CODE>static&nbsp;short</CODE></FONT></TD>
 184 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#SENSOR2_MASK">SENSOR2_MASK</A></B></CODE>
 185
 186 <BR>
 187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 188 </TR>
 189 <TR BGCOLOR="white" CLASS="TableRowColor">
 190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 191 <CODE>static&nbsp;short</CODE></FONT></TD>
 192 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#SENSOR3_MASK">SENSOR3_MASK</A></B></CODE>
 193
 194 <BR>
 195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 196 </TR>
 197 <TR BGCOLOR="white" CLASS="TableRowColor">
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 199 <CODE>static&nbsp;short</CODE></FONT></TD>
 200 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#SENSOR4_MASK">SENSOR4_MASK</A></B></CODE>
 201
 202 <BR>
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 204 </TR>
 205 <TR BGCOLOR="white" CLASS="TableRowColor">
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 207 <CODE>static&nbsp;short</CODE></FONT></TD>
 208 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#SERIAL_MASK">SERIAL_MASK</A></B></CODE>
 209
 210 <BR>
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 212 </TR>
 213 <TR BGCOLOR="white" CLASS="TableRowColor">
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 215 <CODE>static&nbsp;short</CODE></FONT></TD>
 216 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#SERIAL_SHIFT">SERIAL_SHIFT</A></B></CODE>
 217
 218 <BR>
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 220 </TR>
 221 </TABLE>
 222 &nbsp;
 223 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 224
 225 <A NAME="constructor_summary"><!-- --></A>
 226 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 227 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 228 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 229 <B>Constructor Summary</B></FONT></TH>
 230 </TR>
 231 <TR BGCOLOR="white" CLASS="TableRowColor">
 232 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#Poll()">Poll</A></B>()</CODE>
 233
 234 <BR>
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
 236 </TR>
 237 </TABLE>
 238 &nbsp;
 239 <!-- ========== METHOD SUMMARY =========== -->
 240
 241 <A NAME="method_summary"><!-- --></A>
 242 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 243 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 244 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 245 <B>Method Summary</B></FONT></TH>
 246 </TR>
 247 <TR BGCOLOR="white" CLASS="TableRowColor">
 248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 249 <CODE>&nbsp;int</CODE></FONT></TD>
 250 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#poll(int, int)">poll</A></B>(int&nbsp;mask,
 251      int&nbsp;millis)</CODE>
 252
 253 <BR>
 254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Wait for the sensor/button values to change then return.</TD>
 255 </TR>
 256 <TR BGCOLOR="white" CLASS="TableRowColor">
 257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 258 <CODE>&nbsp;void</CODE></FONT></TD>
 259 <TD><CODE><B><A HREF="../../lejos/nxt/Poll.html#setThrottle(int)">setThrottle</A></B>(int&nbsp;throttle)</CODE>
 260
 261 <BR>
 262 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a throttle on the regularity with which inputs
 263  are polled.</TD>
 264 </TR>
 265 </TABLE>
 266 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 267 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 268 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 269 <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>
 270 </TR>
 271 <TR BGCOLOR="white" CLASS="TableRowColor">
 272 <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>
 273 </TR>
 274 </TABLE>
 275 &nbsp;
 276 <P>
 277
 278 <!-- ============ FIELD DETAIL =========== -->
 279
 280 <A NAME="field_detail"><!-- --></A>
 281 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 282 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 283 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 284 <B>Field Detail</B></FONT></TH>
 285 </TR>
 286 </TABLE>
 287
 288 <A NAME="SENSOR1_MASK"><!-- --></A><H3>
 289 SENSOR1_MASK</H3>
 290 <PRE>
 291 public static final short <B>SENSOR1_MASK</B></PRE>
 292 <DL>
 293 <DL>
 294 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.SENSOR1_MASK">Constant Field Values</A></DL>
 295 </DL>
 296 <HR>
 297
 298 <A NAME="SENSOR2_MASK"><!-- --></A><H3>
 299 SENSOR2_MASK</H3>
 300 <PRE>
 301 public static final short <B>SENSOR2_MASK</B></PRE>
 302 <DL>
 303 <DL>
 304 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.SENSOR2_MASK">Constant Field Values</A></DL>
 305 </DL>
 306 <HR>
 307
 308 <A NAME="SENSOR3_MASK"><!-- --></A><H3>
 309 SENSOR3_MASK</H3>
 310 <PRE>
 311 public static final short <B>SENSOR3_MASK</B></PRE>
 312 <DL>
 313 <DL>
 314 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.SENSOR3_MASK">Constant Field Values</A></DL>
 315 </DL>
 316 <HR>
 317
 318 <A NAME="SENSOR4_MASK"><!-- --></A><H3>
 319 SENSOR4_MASK</H3>
 320 <PRE>
 321 public static final short <B>SENSOR4_MASK</B></PRE>
 322 <DL>
 323 <DL>
 324 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.SENSOR4_MASK">Constant Field Values</A></DL>
 325 </DL>
 326 <HR>
 327
 328 <A NAME="ALL_SENSORS"><!-- --></A><H3>
 329 ALL_SENSORS</H3>
 330 <PRE>
 331 public static final short <B>ALL_SENSORS</B></PRE>
 332 <DL>
 333 <DL>
 334 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.ALL_SENSORS">Constant Field Values</A></DL>
 335 </DL>
 336 <HR>
 337
 338 <A NAME="ENTER_MASK"><!-- --></A><H3>
 339 ENTER_MASK</H3>
 340 <PRE>
 341 public static final short <B>ENTER_MASK</B></PRE>
 342 <DL>
 343 <DL>
 344 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.ENTER_MASK">Constant Field Values</A></DL>
 345 </DL>
 346 <HR>
 347
 348 <A NAME="LEFT_MASK"><!-- --></A><H3>
 349 LEFT_MASK</H3>
 350 <PRE>
 351 public static final short <B>LEFT_MASK</B></PRE>
 352 <DL>
 353 <DL>
 354 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.LEFT_MASK">Constant Field Values</A></DL>
 355 </DL>
 356 <HR>
 357
 358 <A NAME="RIGHT_MASK"><!-- --></A><H3>
 359 RIGHT_MASK</H3>
 360 <PRE>
 361 public static final short <B>RIGHT_MASK</B></PRE>
 362 <DL>
 363 <DL>
 364 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.RIGHT_MASK">Constant Field Values</A></DL>
 365 </DL>
 366 <HR>
 367
 368 <A NAME="ESCAPE_MASK"><!-- --></A><H3>
 369 ESCAPE_MASK</H3>
 370 <PRE>
 371 public static final short <B>ESCAPE_MASK</B></PRE>
 372 <DL>
 373 <DL>
 374 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.ESCAPE_MASK">Constant Field Values</A></DL>
 375 </DL>
 376 <HR>
 377
 378 <A NAME="ALL_BUTTONS"><!-- --></A><H3>
 379 ALL_BUTTONS</H3>
 380 <PRE>
 381 public static final short <B>ALL_BUTTONS</B></PRE>
 382 <DL>
 383 <DL>
 384 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.ALL_BUTTONS">Constant Field Values</A></DL>
 385 </DL>
 386 <HR>
 387
 388 <A NAME="BUTTON_MASK_SHIFT"><!-- --></A><H3>
 389 BUTTON_MASK_SHIFT</H3>
 390 <PRE>
 391 public static final short <B>BUTTON_MASK_SHIFT</B></PRE>
 392 <DL>
 393 <DL>
 394 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.BUTTON_MASK_SHIFT">Constant Field Values</A></DL>
 395 </DL>
 396 <HR>
 397
 398 <A NAME="SERIAL_MASK"><!-- --></A><H3>
 399 SERIAL_MASK</H3>
 400 <PRE>
 401 public static final short <B>SERIAL_MASK</B></PRE>
 402 <DL>
 403 <DL>
 404 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.SERIAL_MASK">Constant Field Values</A></DL>
 405 </DL>
 406 <HR>
 407
 408 <A NAME="SERIAL_SHIFT"><!-- --></A><H3>
 409 SERIAL_SHIFT</H3>
 410 <PRE>
 411 public static final short <B>SERIAL_SHIFT</B></PRE>
 412 <DL>
 413 <DL>
 414 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#lejos.nxt.Poll.SERIAL_SHIFT">Constant Field Values</A></DL>
 415 </DL>
 416
 417 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 418
 419 <A NAME="constructor_detail"><!-- --></A>
 420 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 421 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 422 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 423 <B>Constructor Detail</B></FONT></TH>
 424 </TR>
 425 </TABLE>
 426
 427 <A NAME="Poll()"><!-- --></A><H3>
 428 Poll</H3>
 429 <PRE>
 430 public <B>Poll</B>()</PRE>
 431 <DL>
 432 <DD>Constructor.
 433 <P>
 434 </DL>
 435
 436 <!-- ============ METHOD DETAIL ========== -->
 437
 438 <A NAME="method_detail"><!-- --></A>
 439 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 440 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 441 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 442 <B>Method Detail</B></FONT></TH>
 443 </TR>
 444 </TABLE>
 445
 446 <A NAME="poll(int, int)"><!-- --></A><H3>
 447 poll</H3>
 448 <PRE>
 449 public final int <B>poll</B>(int&nbsp;mask,
 450                       int&nbsp;millis)
 451                throws <A HREF="../../java/lang/InterruptedException.html" title="class in java.lang">InterruptedException</A></PRE>
 452 <DL>
 453 <DD>Wait for the sensor/button values to change then return.
 454 <P>
 455 <DD><DL>
 456 <DT><B>Parameters:</B><DD><CODE>mask</CODE> - bit mask of values to monitor.<DD><CODE>millis</CODE> - wait for at most millis milliseconds. 0 = forever.
 457 <DT><B>Returns:</B><DD>a bit mask of the values that have changed
 458 <DT><B>Throws:</B>
 459 <DD><CODE><A HREF="../../java/lang/InterruptedException.html" title="class in java.lang">InterruptedException</A></CODE></DL>
 460 </DD>
 461 </DL>
 462 <HR>
 463
 464 <A NAME="setThrottle(int)"><!-- --></A><H3>
 465 setThrottle</H3>
 466 <PRE>
 467 public final void <B>setThrottle</B>(int&nbsp;throttle)</PRE>
 468 <DL>
 469 <DD>Set a throttle on the regularity with which inputs
 470  are polled.
 471 <P>
 472 <DD><DL>
 473 <DT><B>Parameters:</B><DD><CODE>throttle</CODE> - number of sensor reads between polls.
 474  Default value is 1. 0 means poll as often as possible.
 475  Sensor reads occur every 3ms.</DL>
 476 </DD>
 477 </DL>
 478 <!-- ========= END OF CLASS DATA ========= -->
 479 <HR>
 480
 481
 482 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 483 <A NAME="navbar_bottom"><!-- --></A>
 484 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 485 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 486 <TR>
 487 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 488 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 489 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 490   <TR ALIGN="center" VALIGN="top">
 491   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 492   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 493   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 494   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 495   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 496   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 497   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 498   </TR>
 499 </TABLE>
 500 </TD>
 501 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 502 </EM>
 503 </TD>
 504 </TR>
 505
 506 <TR>
 507 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 508 &nbsp;<A HREF="../../lejos/nxt/NXTCam.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
 509 &nbsp;<A HREF="../../lejos/nxt/RCXLightSensor.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
 510 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 511   <A HREF="../../index.html?lejos/nxt/Poll.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 512 &nbsp;<A HREF="Poll.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 513 &nbsp;<SCRIPT type="text/javascript">
 514   <!--
 515   if(window==top) {
 516     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 517   }
 518   //-->
 519 </SCRIPT>
 520 <NOSCRIPT>
 521   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 522 </NOSCRIPT>
 523
 524
 525 </FONT></TD>
 526 </TR>
 527 <TR>
 528 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 529   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 530 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 531 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 532 </TR>
 533 </TABLE>
 534 <A NAME="skip-navbar_bottom"></A>
 535 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 536
 537 <HR>
 538
 539 </BODY>
 540 </HTML>