nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/GyroSensor.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 GyroSensor (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.GyroSensor 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="GyroSensor (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/Flash.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/nxt/I2CPort.html" title="interface 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/GyroSensor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="GyroSensor.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 GyroSensor</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.GyroSensor</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>GyroSensor</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 Support the HiTechnic Gyro sensor - untested.
 104  http://www.hitechnic.com/
 105 <P>
 106
 107 <P>
 108 <DL>
 109 <DT><B>Author:</B></DT>
 110   <DD>Lawrie Griffiths</DD>
 111 </DL>
 112 <HR>
 113
 114 <P>
 115 <!-- =========== FIELD SUMMARY =========== -->
 116
 117 <A NAME="field_summary"><!-- --></A>
 118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 120 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 121 <B>Field Summary</B></FONT></TH>
 122 </TR>
 123 </TABLE>
 124 &nbsp;<A NAME="fields_inherited_from_class_lejos.nxt.SensorConstants"><!-- --></A>
 125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 126 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 127 <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>
 128 </TR>
 129 <TR BGCOLOR="white" CLASS="TableRowColor">
 130 <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>
 131 </TR>
 132 </TABLE>
 133 &nbsp;
 134 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 135
 136 <A NAME="constructor_summary"><!-- --></A>
 137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 139 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 140 <B>Constructor Summary</B></FONT></TH>
 141 </TR>
 142 <TR BGCOLOR="white" CLASS="TableRowColor">
 143 <TD><CODE><B><A HREF="../../lejos/nxt/GyroSensor.html#GyroSensor(lejos.nxt.ADSensorPort)">GyroSensor</A></B>(<A HREF="../../lejos/nxt/ADSensorPort.html" title="interface in lejos.nxt">ADSensorPort</A>&nbsp;port)</CODE>
 144
 145 <BR>
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 147 </TR>
 148 </TABLE>
 149 &nbsp;
 150 <!-- ========== METHOD SUMMARY =========== -->
 151
 152 <A NAME="method_summary"><!-- --></A>
 153 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 154 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 155 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 156 <B>Method Summary</B></FONT></TH>
 157 </TR>
 158 <TR BGCOLOR="white" CLASS="TableRowColor">
 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 160 <CODE>&nbsp;int</CODE></FONT></TD>
 161 <TD><CODE><B><A HREF="../../lejos/nxt/GyroSensor.html#readValue()">readValue</A></B>()</CODE>
 162
 163 <BR>
 164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read the gyro value</TD>
 165 </TR>
 166 <TR BGCOLOR="white" CLASS="TableRowColor">
 167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 168 <CODE>&nbsp;void</CODE></FONT></TD>
 169 <TD><CODE><B><A HREF="../../lejos/nxt/GyroSensor.html#setOffset(int)">setOffset</A></B>(int&nbsp;offset)</CODE>
 170
 171 <BR>
 172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the offset</TD>
 173 </TR>
 174 </TABLE>
 175 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 177 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 178 <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>
 179 </TR>
 180 <TR BGCOLOR="white" CLASS="TableRowColor">
 181 <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>
 182 </TR>
 183 </TABLE>
 184 &nbsp;
 185 <P>
 186
 187 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 188
 189 <A NAME="constructor_detail"><!-- --></A>
 190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 192 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 193 <B>Constructor Detail</B></FONT></TH>
 194 </TR>
 195 </TABLE>
 196
 197 <A NAME="GyroSensor(lejos.nxt.ADSensorPort)"><!-- --></A><H3>
 198 GyroSensor</H3>
 199 <PRE>
 200 public <B>GyroSensor</B>(<A HREF="../../lejos/nxt/ADSensorPort.html" title="interface in lejos.nxt">ADSensorPort</A>&nbsp;port)</PRE>
 201 <DL>
 202 </DL>
 203
 204 <!-- ============ METHOD DETAIL ========== -->
 205
 206 <A NAME="method_detail"><!-- --></A>
 207 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 208 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 209 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 210 <B>Method Detail</B></FONT></TH>
 211 </TR>
 212 </TABLE>
 213
 214 <A NAME="readValue()"><!-- --></A><H3>
 215 readValue</H3>
 216 <PRE>
 217 public int <B>readValue</B>()</PRE>
 218 <DL>
 219 <DD>Read the gyro value
 220 <P>
 221 <DD><DL>
 222 </DL>
 223 </DD>
 224 <DD><DL>
 225
 226 <DT><B>Returns:</B><DD>gyro value</DL>
 227 </DD>
 228 </DL>
 229 <HR>
 230
 231 <A NAME="setOffset(int)"><!-- --></A><H3>
 232 setOffset</H3>
 233 <PRE>
 234 public void <B>setOffset</B>(int&nbsp;offset)</PRE>
 235 <DL>
 236 <DD>Set the offset
 237 <P>
 238 <DD><DL>
 239 </DL>
 240 </DD>
 241 <DD><DL>
 242 </DL>
 243 </DD>
 244 </DL>
 245 <!-- ========= END OF CLASS DATA ========= -->
 246 <HR>
 247
 248
 249 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 250 <A NAME="navbar_bottom"><!-- --></A>
 251 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 252 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 253 <TR>
 254 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 255 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 256 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 257   <TR ALIGN="center" VALIGN="top">
 258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 260   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 261   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 262   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 263   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 264   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 265   </TR>
 266 </TABLE>
 267 </TD>
 268 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 269 </EM>
 270 </TD>
 271 </TR>
 272
 273 <TR>
 274 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 275 &nbsp;<A HREF="../../lejos/nxt/Flash.html" title="class in lejos.nxt"><B>PREV CLASS</B></A>&nbsp;
 276 &nbsp;<A HREF="../../lejos/nxt/I2CPort.html" title="interface in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
 277 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 278   <A HREF="../../index.html?lejos/nxt/GyroSensor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 279 &nbsp;<A HREF="GyroSensor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 280 &nbsp;<SCRIPT type="text/javascript">
 281   <!--
 282   if(window==top) {
 283     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 284   }
 285   //-->
 286 </SCRIPT>
 287 <NOSCRIPT>
 288   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 289 </NOSCRIPT>
 290
 291
 292 </FONT></TD>
 293 </TR>
 294 <TR>
 295 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 296   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 297 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 298 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 299 </TR>
 300 </TABLE>
 301 <A NAME="skip-navbar_bottom"></A>
 302 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 303
 304 <HR>
 305
 306 </BODY>
 307 </HTML>