nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/UltrasonicSensor.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 UltrasonicSensor (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.UltrasonicSensor 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="UltrasonicSensor (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/TouchSensor.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;NEXT CLASS</FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../index.html?lejos/nxt/UltrasonicSensor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="UltrasonicSensor.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 UltrasonicSensor</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 "><A HREF="../../lejos/nxt/I2CSensor.html" title="class in lejos.nxt">lejos.nxt.I2CSensor</A>
  93       <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.nxt.UltrasonicSensor</B>
  94 </PRE>
  95 <DL>
  96 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../lejos/nxt/SensorConstants.html" title="interface in lejos.nxt">SensorConstants</A></DD>
  97 </DL>
  98 <HR>
  99 <DL>
 100 <DT><PRE>public class <B>UltrasonicSensor</B><DT>extends <A HREF="../../lejos/nxt/I2CSensor.html" title="class in lejos.nxt">I2CSensor</A></DL>
 101 </PRE>
 102
 103 <P>
 104 Abstraction for a NXT Ultrasonic Sensor.
 105 <P>
 106
 107 <P>
 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 </TABLE>
 120 &nbsp;<A NAME="fields_inherited_from_class_lejos.nxt.SensorConstants"><!-- --></A>
 121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 122 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 123 <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>
 124 </TR>
 125 <TR BGCOLOR="white" CLASS="TableRowColor">
 126 <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>
 127 </TR>
 128 </TABLE>
 129 &nbsp;
 130 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 131
 132 <A NAME="constructor_summary"><!-- --></A>
 133 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 134 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 135 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 136 <B>Constructor Summary</B></FONT></TH>
 137 </TR>
 138 <TR BGCOLOR="white" CLASS="TableRowColor">
 139 <TD><CODE><B><A HREF="../../lejos/nxt/UltrasonicSensor.html#UltrasonicSensor(lejos.nxt.I2CPort)">UltrasonicSensor</A></B>(lejos.nxt.I2CPort&nbsp;port)</CODE>
 140
 141 <BR>
 142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 143 </TR>
 144 </TABLE>
 145 &nbsp;
 146 <!-- ========== METHOD SUMMARY =========== -->
 147
 148 <A NAME="method_summary"><!-- --></A>
 149 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 150 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 151 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 152 <B>Method Summary</B></FONT></TH>
 153 </TR>
 154 <TR BGCOLOR="white" CLASS="TableRowColor">
 155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 156 <CODE>&nbsp;int</CODE></FONT></TD>
 157 <TD><CODE><B><A HREF="../../lejos/nxt/UltrasonicSensor.html#getDistance()">getDistance</A></B>()</CODE>
 158
 159 <BR>
 160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return distance of object.</TD>
 161 </TR>
 162 </TABLE>
 163 &nbsp;<A NAME="methods_inherited_from_class_lejos.nxt.I2CSensor"><!-- --></A>
 164 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 165 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 166 <TH ALIGN="left"><B>Methods inherited from class lejos.nxt.<A HREF="../../lejos/nxt/I2CSensor.html" title="class in lejos.nxt">I2CSensor</A></B></TH>
 167 </TR>
 168 <TR BGCOLOR="white" CLASS="TableRowColor">
 169 <TD><CODE><A HREF="../../lejos/nxt/I2CSensor.html#getData(int, byte[], int)">getData</A>, <A HREF="../../lejos/nxt/I2CSensor.html#getProductID()">getProductID</A>, <A HREF="../../lejos/nxt/I2CSensor.html#getSensorType()">getSensorType</A>, <A HREF="../../lejos/nxt/I2CSensor.html#getVersion()">getVersion</A>, <A HREF="../../lejos/nxt/I2CSensor.html#sendData(int, byte[], int)">sendData</A></CODE></TD>
 170 </TR>
 171 </TABLE>
 172 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 174 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 175 <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>
 176 </TR>
 177 <TR BGCOLOR="white" CLASS="TableRowColor">
 178 <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>
 179 </TR>
 180 </TABLE>
 181 &nbsp;
 182 <P>
 183
 184 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 185
 186 <A NAME="constructor_detail"><!-- --></A>
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 188 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 189 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 190 <B>Constructor Detail</B></FONT></TH>
 191 </TR>
 192 </TABLE>
 193
 194 <A NAME="UltrasonicSensor(lejos.nxt.I2CPort)"><!-- --></A><H3>
 195 UltrasonicSensor</H3>
 196 <PRE>
 197 public <B>UltrasonicSensor</B>(lejos.nxt.I2CPort&nbsp;port)</PRE>
 198 <DL>
 199 </DL>
 200
 201 <!-- ============ METHOD DETAIL ========== -->
 202
 203 <A NAME="method_detail"><!-- --></A>
 204 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 205 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 206 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 207 <B>Method Detail</B></FONT></TH>
 208 </TR>
 209 </TABLE>
 210
 211 <A NAME="getDistance()"><!-- --></A><H3>
 212 getDistance</H3>
 213 <PRE>
 214 public int <B>getDistance</B>()</PRE>
 215 <DL>
 216 <DD>Return distance of object.
 217 <P>
 218 <DD><DL>
 219
 220 <DT><B>Returns:</B><DD>distance or 255 if no object in range</DL>
 221 </DD>
 222 </DL>
 223 <!-- ========= END OF CLASS DATA ========= -->
 224 <HR>
 225
 226
 227 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 228 <A NAME="navbar_bottom"><!-- --></A>
 229 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 230 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 231 <TR>
 232 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 233 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 234 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 235   <TR ALIGN="center" VALIGN="top">
 236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 237   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 238   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 241   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 243   </TR>
 244 </TABLE>
 245 </TD>
 246 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 247 </EM>
 248 </TD>
 249 </TR>
 250
 251 <TR>
 252 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 253 &nbsp;<A HREF="../../lejos/nxt/TouchSensor.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
 254 &nbsp;NEXT CLASS</FONT></TD>
 255 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 256   <A HREF="../../index.html?lejos/nxt/UltrasonicSensor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 257 &nbsp;<A HREF="UltrasonicSensor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 258 &nbsp;<SCRIPT type="text/javascript">
 259   <!--
 260   if(window==top) {
 261     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 262   }
 263   //-->
 264 </SCRIPT>
 265 <NOSCRIPT>
 266   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 267 </NOSCRIPT>
 268
 269
 270 </FONT></TD>
 271 </TR>
 272 <TR>
 273 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 274   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 275 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 276 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 277 </TR>
 278 </TABLE>
 279 <A NAME="skip-navbar_bottom"></A>
 280 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 281
 282 <HR>
 283
 284 </BODY>
 285 </HTML>