OSDN Git Service

Update ecrobot to nxtOSEK_v212.zip
[nxt-jsp/etrobo-atk.git] / nxtOSEK / ecrobot / c++ / html / classecrobot_1_1_sensor.html
diff --git a/nxtOSEK/ecrobot/c++/html/classecrobot_1_1_sensor.html b/nxtOSEK/ecrobot/c++/html/classecrobot_1_1_sensor.html
new file mode 100644 (file)
index 0000000..2e8f944
--- /dev/null
@@ -0,0 +1,194 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>ECRobot C++ API for LEGO MINDSTORMS NXT: ecrobot::Sensor Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.1 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+  <div class="navpath"><b>ecrobot</b>::<a class="el" href="classecrobot_1_1_sensor.html">Sensor</a>
+  </div>
+</div>
+<div class="contents">
+<h1>ecrobot::Sensor Class Reference</h1><!-- doxytag: class="ecrobot::Sensor" -->
+<p>A/D sensor abstract class.  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="_sensor_8h_source.html">Sensor.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for ecrobot::Sensor:</div>
+<div class="dynsection">
+ <div class="center">
+  <img src="classecrobot_1_1_sensor.gif" usemap="#ecrobot::Sensor_map" alt=""/>
+  <map id="ecrobot::Sensor_map" name="ecrobot::Sensor_map">
+<area href="classecrobot_1_1_gyro_sensor.html" alt="ecrobot::GyroSensor" shape="rect" coords="0,56,149,80"/>
+<area href="classecrobot_1_1_light_sensor.html" alt="ecrobot::LightSensor" shape="rect" coords="159,56,308,80"/>
+<area href="classecrobot_1_1_rcx_light_sensor.html" alt="ecrobot::RcxLightSensor" shape="rect" coords="318,56,467,80"/>
+<area href="classecrobot_1_1_sound_sensor.html" alt="ecrobot::SoundSensor" shape="rect" coords="477,56,626,80"/>
+<area href="classecrobot_1_1_touch_sensor.html" alt="ecrobot::TouchSensor" shape="rect" coords="636,56,785,80"/>
+</map>
+ </div>
+</div>
+
+<p><a href="classecrobot_1_1_sensor-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">S16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_sensor.html#a925d9e3d3f6b54e312c2b9bb1d0e1dbb">get</a> (void) const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get raw A/D value.  <a href="#a925d9e3d3f6b54e312c2b9bb1d0e1dbb"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_port_8h.html#a8d17f8fabb486d5815d626610983e82d">ePortS</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_sensor.html#abce088139bc8512a2a4507c4e753dc7f">getPort</a> (void) const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the sensor connected port.  <a href="#abce088139bc8512a2a4507c4e753dc7f"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_sensor.html#af9869fd958f21d8cd78112450823bfec">Sensor</a> (<a class="el" href="_port_8h.html#a8d17f8fabb486d5815d626610983e82d">ePortS</a> port, <a class="el" href="_port_8h.html#a0de7742117569a1ace9ea7cc1448e2db">ePower</a> power=POWER_OFF)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#af9869fd958f21d8cd78112450823bfec"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_sensor.html#a3f92ce59eafdbd3b8005fa76767cd016">~Sensor</a> (void)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor (power off the sensor).  <a href="#a3f92ce59eafdbd3b8005fa76767cd016"></a><br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>A/D sensor abstract class. </p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="af9869fd958f21d8cd78112450823bfec"></a><!-- doxytag: member="ecrobot::Sensor::Sensor" ref="af9869fd958f21d8cd78112450823bfec" args="(ePortS port, ePower power=POWER_OFF)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">ecrobot::Sensor::Sensor </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="_port_8h.html#a8d17f8fabb486d5815d626610983e82d">ePortS</a>&nbsp;</td>
+          <td class="paramname"> <em>port</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="_port_8h.html#a0de7742117569a1ace9ea7cc1448e2db">ePower</a>&nbsp;</td>
+          <td class="paramname"> <em>power</em> = <code>POWER_OFF</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [inline, explicit, protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Constructor. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td><a class="el" href="classecrobot_1_1_sensor.html" title="A/D sensor abstract class.">Sensor</a> connected port </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>power</em>&nbsp;</td><td>Power mode </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>- </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a3f92ce59eafdbd3b8005fa76767cd016"></a><!-- doxytag: member="ecrobot::Sensor::~Sensor" ref="a3f92ce59eafdbd3b8005fa76767cd016" args="(void)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual ecrobot::Sensor::~Sensor </td>
+          <td>(</td>
+          <td class="paramtype">void&nbsp;</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, protected, virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Destructor (power off the sensor). </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>- </dd></dl>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a925d9e3d3f6b54e312c2b9bb1d0e1dbb"></a><!-- doxytag: member="ecrobot::Sensor::get" ref="a925d9e3d3f6b54e312c2b9bb1d0e1dbb" args="(void) const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">S16 ecrobot::Sensor::get </td>
+          <td>(</td>
+          <td class="paramtype">void&nbsp;</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [inline]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Get raw A/D value. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>raw A/D value (0 to 1023) </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="abce088139bc8512a2a4507c4e753dc7f"></a><!-- doxytag: member="ecrobot::Sensor::getPort" ref="abce088139bc8512a2a4507c4e753dc7f" args="(void) const " -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="_port_8h.html#a8d17f8fabb486d5815d626610983e82d">ePortS</a> ecrobot::Sensor::getPort </td>
+          <td>(</td>
+          <td class="paramtype">void&nbsp;</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td> const<code> [inline, protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Get the sensor connected port. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classecrobot_1_1_sensor.html" title="A/D sensor abstract class.">Sensor</a> connected port </dd></dl>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>device/<a class="el" href="_sensor_8h_source.html">Sensor.h</a></li>
+</ul>
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Dec 29 11:38:02 2009 for ECRobot C++ API for LEGO MINDSTORMS NXT by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
+</body>
+</html>