nxtOSEK/lejos_nxj/docs/apidocs/lejos/nxt/Battery.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 Mar 27 00:00:26 BST 2007 -->
   6 <TITLE>
   7 Battery (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.nxt.Battery 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="Battery (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;PREV CLASS&nbsp;
  55 &nbsp;<A HREF="../../lejos/nxt/Button.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/Battery.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="Battery.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;CONSTR&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;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 Battery</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.Battery</B>
  93 </PRE>
  94 <HR>
  95 <DL>
  96 <DT><PRE>public class <B>Battery</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
  97 </PRE>
  98
  99 <P>
 100 Provides access to Battery.
 101 <P>
 102
 103 <P>
 104 <HR>
 105
 106 <P>
 107
 108 <!-- ========== METHOD SUMMARY =========== -->
 109
 110 <A NAME="method_summary"><!-- --></A>
 111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 113 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 114 <B>Method Summary</B></FONT></TH>
 115 </TR>
 116 <TR BGCOLOR="white" CLASS="TableRowColor">
 117 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 118 <CODE>static&nbsp;float</CODE></FONT></TD>
 119 <TD><CODE><B><A HREF="../../lejos/nxt/Battery.html#getVoltage()">getVoltage</A></B>()</CODE>
 120
 121 <BR>
 122 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the battery voltage in volts.</TD>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 126 <CODE>static&nbsp;int</CODE></FONT></TD>
 127 <TD><CODE><B><A HREF="../../lejos/nxt/Battery.html#getVoltageMilliVolt()">getVoltageMilliVolt</A></B>()</CODE>
 128
 129 <BR>
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the battery voltage in millivolts.</TD>
 131 </TR>
 132 </TABLE>
 133 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 135 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 136 <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>
 137 </TR>
 138 <TR BGCOLOR="white" CLASS="TableRowColor">
 139 <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>
 140 </TR>
 141 </TABLE>
 142 &nbsp;
 143 <P>
 144
 145 <!-- ============ METHOD DETAIL ========== -->
 146
 147 <A NAME="method_detail"><!-- --></A>
 148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 150 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 151 <B>Method Detail</B></FONT></TH>
 152 </TR>
 153 </TABLE>
 154
 155 <A NAME="getVoltageMilliVolt()"><!-- --></A><H3>
 156 getVoltageMilliVolt</H3>
 157 <PRE>
 158 public static int <B>getVoltageMilliVolt</B>()</PRE>
 159 <DL>
 160 <DD>Returns the battery voltage in millivolts.
 161 <P>
 162 <DD><DL>
 163
 164 <DT><B>Returns:</B><DD>Battery voltage in mV.</DL>
 165 </DD>
 166 </DL>
 167 <HR>
 168
 169 <A NAME="getVoltage()"><!-- --></A><H3>
 170 getVoltage</H3>
 171 <PRE>
 172 public static float <B>getVoltage</B>()</PRE>
 173 <DL>
 174 <DD>Returns the battery voltage in volts.
 175 <P>
 176 <DD><DL>
 177
 178 <DT><B>Returns:</B><DD>Battery voltage in Volt.</DL>
 179 </DD>
 180 </DL>
 181 <!-- ========= END OF CLASS DATA ========= -->
 182 <HR>
 183
 184
 185 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 186 <A NAME="navbar_bottom"><!-- --></A>
 187 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 188 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 189 <TR>
 190 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 191 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 192 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 193   <TR ALIGN="center" VALIGN="top">
 194   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 195   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 196   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 197   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 198   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 199   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 200   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 201   </TR>
 202 </TABLE>
 203 </TD>
 204 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 205 </EM>
 206 </TD>
 207 </TR>
 208
 209 <TR>
 210 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 211 &nbsp;PREV CLASS&nbsp;
 212 &nbsp;<A HREF="../../lejos/nxt/Button.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
 213 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 214   <A HREF="../../index.html?lejos/nxt/Battery.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 215 &nbsp;<A HREF="Battery.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 216 &nbsp;<SCRIPT type="text/javascript">
 217   <!--
 218   if(window==top) {
 219     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 220   }
 221   //-->
 222 </SCRIPT>
 223 <NOSCRIPT>
 224   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 225 </NOSCRIPT>
 226
 227
 228 </FONT></TD>
 229 </TR>
 230 <TR>
 231 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 232   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 233 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 234 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 235 </TR>
 236 </TABLE>
 237 <A NAME="skip-navbar_bottom"></A>
 238 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 239
 240 <HR>
 241
 242 </BODY>
 243 </HTML>