nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/RCXLightSensor.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 Sun Sep 02 23:07:09 BST 2007 -->
   6 <TITLE>
   7 RCXLightSensor (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.RCXLightSensor 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="RCXLightSensor (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/Poll.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/nxt/RCXMotor.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/RCXLightSensor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="RCXLightSensor.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;FIELD&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;FIELD&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 RCXLightSensor</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.RCXLightSensor</B>
  93 </PRE>
  94 <DL>
  95 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../lejos/nxt/SensorConstants.html" title="interface in lejos.nxt">SensorConstants</A></DD>
  96 </DL>
  97 <HR>
  98 <DL>
  99 <DT><PRE>public class <B>RCXLightSensor</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A><DT>implements <A HREF="../../lejos/nxt/SensorConstants.html" title="interface in lejos.nxt">SensorConstants</A></DL>
 100 </PRE>
 101
 102 <P>
 103 Abstraction for an RCX light sensor.
 104 <P>
 105
 106 <P>
 107 <HR>
 108
 109 <P>
 110 <!-- =========== FIELD SUMMARY =========== -->
 111
 112 <A NAME="field_summary"><!-- --></A>
 113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 116 <B>Field Summary</B></FONT></TH>
 117 </TR>
 118 </TABLE>
 119 &nbsp;<A NAME="fields_inherited_from_class_lejos.nxt.SensorConstants"><!-- --></A>
 120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 121 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 122 <TH ALIGN="left"><B>Fields inherited from interface lejos.nxt.<A HREF="../../lejos/nxt/SensorConstants.html" title="interface in lejos.nxt">SensorConstants</A></B></TH>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD><CODE><A HREF="../../lejos/nxt/SensorConstants.html#MODE_ANGLESTEP">MODE_ANGLESTEP</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_BOOLEAN">MODE_BOOLEAN</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_CELSIUS">MODE_CELSIUS</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_FARENHEIT">MODE_FARENHEIT</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_PCTFULLSCALE">MODE_PCTFULLSCALE</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_PERIODCOUNTER">MODE_PERIODCOUNTER</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_RAW">MODE_RAW</A>, <A HREF="../../lejos/nxt/SensorConstants.html#MODE_TRANSITIONCNT">MODE_TRANSITIONCNT</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_ANGLE">TYPE_ANGLE</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_CUSTOM">TYPE_CUSTOM</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_LIGHT_ACTIVE">TYPE_LIGHT_ACTIVE</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_LIGHT_INACTIVE">TYPE_LIGHT_INACTIVE</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_LOWSPEED">TYPE_LOWSPEED</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_LOWSPEED_9V">TYPE_LOWSPEED_9V</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_NO_SENSOR">TYPE_NO_SENSOR</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_REFLECTION">TYPE_REFLECTION</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_SOUND_DB">TYPE_SOUND_DB</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_SOUND_DBA">TYPE_SOUND_DBA</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_SWITCH">TYPE_SWITCH</A>, <A HREF="../../lejos/nxt/SensorConstants.html#TYPE_TEMPERATURE">TYPE_TEMPERATURE</A></CODE></TD>
 126 </TR>
 127 </TABLE>
 128 &nbsp;
 129 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 130
 131 <A NAME="constructor_summary"><!-- --></A>
 132 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 134 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 135 <B>Constructor Summary</B></FONT></TH>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD><CODE><B><A HREF="../../lejos/nxt/RCXLightSensor.html#RCXLightSensor(lejos.nxt.LegacySensorPort)">RCXLightSensor</A></B>(lejos.nxt.LegacySensorPort&nbsp;port)</CODE>
 139
 140 <BR>
 141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an RCX light sensor object attached to the specified port.</TD>
 142 </TR>
 143 </TABLE>
 144 &nbsp;
 145 <!-- ========== METHOD SUMMARY =========== -->
 146
 147 <A NAME="method_summary"><!-- --></A>
 148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 150 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 151 <B>Method Summary</B></FONT></TH>
 152 </TR>
 153 <TR BGCOLOR="white" CLASS="TableRowColor">
 154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 155 <CODE>&nbsp;void</CODE></FONT></TD>
 156 <TD><CODE><B><A HREF="../../lejos/nxt/RCXLightSensor.html#activate()">activate</A></B>()</CODE>
 157
 158 <BR>
 159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Activates an RCX light sensor.</TD>
 160 </TR>
 161 <TR BGCOLOR="white" CLASS="TableRowColor">
 162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 163 <CODE>&nbsp;void</CODE></FONT></TD>
 164 <TD><CODE><B><A HREF="../../lejos/nxt/RCXLightSensor.html#passivate()">passivate</A></B>()</CODE>
 165
 166 <BR>
 167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Passivates an RCX light sensor.</TD>
 168 </TR>
 169 <TR BGCOLOR="white" CLASS="TableRowColor">
 170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 171 <CODE>&nbsp;int</CODE></FONT></TD>
 172 <TD><CODE><B><A HREF="../../lejos/nxt/RCXLightSensor.html#readValue()">readValue</A></B>()</CODE>
 173
 174 <BR>
 175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read the current sensor value.</TD>
 176 </TR>
 177 </TABLE>
 178 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 180 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 181 <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>
 182 </TR>
 183 <TR BGCOLOR="white" CLASS="TableRowColor">
 184 <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>
 185 </TR>
 186 </TABLE>
 187 &nbsp;
 188 <P>
 189
 190 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 191
 192 <A NAME="constructor_detail"><!-- --></A>
 193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 194 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 195 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 196 <B>Constructor Detail</B></FONT></TH>
 197 </TR>
 198 </TABLE>
 199
 200 <A NAME="RCXLightSensor(lejos.nxt.LegacySensorPort)"><!-- --></A><H3>
 201 RCXLightSensor</H3>
 202 <PRE>
 203 public <B>RCXLightSensor</B>(lejos.nxt.LegacySensorPort&nbsp;port)</PRE>
 204 <DL>
 205 <DD>Create an RCX light sensor object attached to the specified port.
 206  The sensor will be activated, i.e. the LED will be turned on.
 207 <P>
 208 <DL>
 209 <DT><B>Parameters:</B><DD><CODE>port</CODE> - port, e.g. Port.S1</DL>
 210 </DL>
 211
 212 <!-- ============ METHOD DETAIL ========== -->
 213
 214 <A NAME="method_detail"><!-- --></A>
 215 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 216 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 217 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 218 <B>Method Detail</B></FONT></TH>
 219 </TR>
 220 </TABLE>
 221
 222 <A NAME="activate()"><!-- --></A><H3>
 223 activate</H3>
 224 <PRE>
 225 public void <B>activate</B>()</PRE>
 226 <DL>
 227 <DD>Activates an RCX light sensor. This method should be called
 228  if you want to get accurate values from an RCX
 229  sensor. In the case of RCX light sensors, you should see
 230  the LED go on when you call this method.
 231 <P>
 232 <DD><DL>
 233 </DL>
 234 </DD>
 235 <DD><DL>
 236 </DL>
 237 </DD>
 238 </DL>
 239 <HR>
 240
 241 <A NAME="passivate()"><!-- --></A><H3>
 242 passivate</H3>
 243 <PRE>
 244 public void <B>passivate</B>()</PRE>
 245 <DL>
 246 <DD>Passivates an RCX light sensor.
 247 <P>
 248 <DD><DL>
 249 </DL>
 250 </DD>
 251 <DD><DL>
 252 </DL>
 253 </DD>
 254 </DL>
 255 <HR>
 256
 257 <A NAME="readValue()"><!-- --></A><H3>
 258 readValue</H3>
 259 <PRE>
 260 public int <B>readValue</B>()</PRE>
 261 <DL>
 262 <DD>Read the current sensor value.
 263 <P>
 264 <DD><DL>
 265 </DL>
 266 </DD>
 267 <DD><DL>
 268
 269 <DT><B>Returns:</B><DD>Value as a percentage.</DL>
 270 </DD>
 271 </DL>
 272 <!-- ========= END OF CLASS DATA ========= -->
 273 <HR>
 274
 275
 276 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 277 <A NAME="navbar_bottom"><!-- --></A>
 278 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 279 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 280 <TR>
 281 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 282 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 283 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 284   <TR ALIGN="center" VALIGN="top">
 285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 286   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 287   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 288   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 289   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 290   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 291   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 292   </TR>
 293 </TABLE>
 294 </TD>
 295 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 296 </EM>
 297 </TD>
 298 </TR>
 299
 300 <TR>
 301 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 302 &nbsp;<A HREF="../../lejos/nxt/Poll.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
 303 &nbsp;<A HREF="../../lejos/nxt/RCXMotor.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
 304 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 305   <A HREF="../../index.html?lejos/nxt/RCXLightSensor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 306 &nbsp;<A HREF="RCXLightSensor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 307 &nbsp;<SCRIPT type="text/javascript">
 308   <!--
 309   if(window==top) {
 310     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 311   }
 312   //-->
 313 </SCRIPT>
 314 <NOSCRIPT>
 315   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 316 </NOSCRIPT>
 317
 318
 319 </FONT></TD>
 320 </TR>
 321 <TR>
 322 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 323   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 324 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 325 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 326 </TR>
 327 </TABLE>
 328 <A NAME="skip-navbar_bottom"></A>
 329 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 330
 331 <HR>
 332
 333 </BODY>
 334 </HTML>