OSDN Git Service

Update ecrobot to nxtOSEK_v212.zip
[nxt-jsp/etrobo-atk.git] / nxtOSEK / ecrobot / c++ / html / classecrobot_1_1_lcd.html
diff --git a/nxtOSEK/ecrobot/c++/html/classecrobot_1_1_lcd.html b/nxtOSEK/ecrobot/c++/html/classecrobot_1_1_lcd.html
new file mode 100644 (file)
index 0000000..b15eb09
--- /dev/null
@@ -0,0 +1,363 @@
+<!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::Lcd 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_lcd.html">Lcd</a>
+  </div>
+</div>
+<div class="contents">
+<h1>ecrobot::Lcd Class Reference</h1><!-- doxytag: class="ecrobot::Lcd" -->
+<p>Simple LCD display class.  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="_lcd_8h_source.html">Lcd.h</a>&gt;</code></p>
+
+<p><a href="classecrobot_1_1_lcd-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a92abca8c9b73d7b0a01a46e17269c61a">Lcd</a> (void)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#a92abca8c9b73d7b0a01a46e17269c61a"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#aec3187f757ddc31b23b48aebf7d1bfdd">cursor</a> (U32 x, U32 y)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set cursor to (x,y) position.  <a href="#aec3187f757ddc31b23b48aebf7d1bfdd"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a31a1d35b0ebb7ecb7b2c3e9b19011932">clear</a> (bool lcdToo=false)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear LCD data buffer and reset cursor position to (0,0).  <a href="#a31a1d35b0ebb7ecb7b2c3e9b19011932"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a11ca0493d2bdb25460fbffb5d6d96f1c">clearRow</a> (U32 row, bool lcdToo=false)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear LCD data buffer at the specified row.  <a href="#a11ca0493d2bdb25460fbffb5d6d96f1c"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a03e68349ef63137aee48ece9ec7c7e4f">putf</a> (const CHAR *format,...)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Put output to the LCD data buffer, according to format and other arguments passed to <a class="el" href="classecrobot_1_1_lcd.html#a03e68349ef63137aee48ece9ec7c7e4f" title="Put output to the LCD data buffer, according to format and other arguments passed...">putf()</a>.  <a href="#a03e68349ef63137aee48ece9ec7c7e4f"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a3dead0edea30c23da5931eb6b830c391">draw</a> (const U8 *data, U32 width, U32 depth, U32 xPosInWidth, U32 yPosInDepth)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw monochrome bit map data to the LCD data buffer.  <a href="#a3dead0edea30c23da5931eb6b830c391"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#ad56a6b9f775aae41f40979a92c8eb3e3">disp</a> (void)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Display data in the LCD data buffer to the LCD.  <a href="#ad56a6b9f775aae41f40979a92c8eb3e3"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab634eed490993c42f9daf72de45c62dc"></a><!-- doxytag: member="ecrobot::Lcd::MAX_CURSOR_X" ref="ab634eed490993c42f9daf72de45c62dc" args="" -->
+static const U32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#ab634eed490993c42f9daf72de45c62dc">MAX_CURSOR_X</a> = 15</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max cursor position in X(horizontal) axis. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9398d86dc509143d55e3a106c934791f"></a><!-- doxytag: member="ecrobot::Lcd::MAX_CURSOR_Y" ref="a9398d86dc509143d55e3a106c934791f" args="" -->
+static const U32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a9398d86dc509143d55e3a106c934791f">MAX_CURSOR_Y</a> = 7</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max cursor position in Y(vertical) axis. <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64c08c258d5aea30191255ecefc84a95"></a><!-- doxytag: member="ecrobot::Lcd::MAX_LCD_WIDTH" ref="a64c08c258d5aea30191255ecefc84a95" args="" -->
+static const U32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#a64c08c258d5aea30191255ecefc84a95">MAX_LCD_WIDTH</a> = 100</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max LCD width (1 width = 1 pixel). <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2bfd9cdccfd4faceafa92a81b86aca1"></a><!-- doxytag: member="ecrobot::Lcd::MAX_LCD_DEPTH" ref="ad2bfd9cdccfd4faceafa92a81b86aca1" args="" -->
+static const U32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecrobot_1_1_lcd.html#ad2bfd9cdccfd4faceafa92a81b86aca1">MAX_LCD_DEPTH</a> = 64/8</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max LCD depth (1 depth = 8 pixels). <br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Simple LCD display class. </p>
+<p>[ Example ]<br/>
+ &nbsp;&nbsp;<a class="el" href="classecrobot_1_1_lcd.html" title="Simple LCD display class.">Lcd</a> lcd;<br/>
+ <br/>
+ &nbsp;&nbsp;lcd.clear();<br/>
+ &nbsp;&nbsp;lcd.putf("s", "Hello");<br/>
+ &nbsp;&nbsp;lcd.putf("s", "World");<br/>
+ &nbsp;&nbsp;lcd.disp();<br/>
+ &nbsp;&nbsp;"HelloWorld"<br/>
+ <br/>
+ &nbsp;&nbsp;lcd.clear();<br/>
+ &nbsp;&nbsp;lcd.putf("s\ns", "Hello", "World");<br/>
+ &nbsp;&nbsp;lcd.disp();<br/>
+ &nbsp;&nbsp;"Hello"<br/>
+ &nbsp;&nbsp;"World"<br/>
+ <br/>
+ &nbsp;&nbsp;lcd.clear();<br/>
+ &nbsp;&nbsp;lcd.putf("d", -10,0);<br/>
+ &nbsp;&nbsp;lcd.disp();<br/>
+ &nbsp;&nbsp;"-10"<br/>
+ <br/>
+ &nbsp;&nbsp;lcd.clear();<br/>
+ &nbsp;&nbsp;lcd.putf("x", 255,0);<br/>
+ &nbsp;&nbsp;lcd.disp();<br/>
+ &nbsp;&nbsp;"FF"<br/>
+ <br/>
+ &nbsp;&nbsp;lcd.clear();<br/>
+ &nbsp;&nbsp;lcd.putf("sddsx", "Calc: ", 16,0, -1,2, "=0x", (16-1),0);<br/>
+ &nbsp;&nbsp;lcd.disp();<br/>
+ &nbsp;&nbsp;"Calc: 16-1=0xF" </p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a92abca8c9b73d7b0a01a46e17269c61a"></a><!-- doxytag: member="ecrobot::Lcd::Lcd" ref="a92abca8c9b73d7b0a01a46e17269c61a" args="(void)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">ecrobot::Lcd::Lcd </td>
+          <td>(</td>
+          <td class="paramtype">void&nbsp;</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></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>-</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="a31a1d35b0ebb7ecb7b2c3e9b19011932"></a><!-- doxytag: member="ecrobot::Lcd::clear" ref="a31a1d35b0ebb7ecb7b2c3e9b19011932" args="(bool lcdToo=false)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ecrobot::Lcd::clear </td>
+          <td>(</td>
+          <td class="paramtype">bool&nbsp;</td>
+          <td class="paramname"> <em>lcdToo</em> = <code>false</code></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Clear LCD data buffer and reset cursor position to (0,0). </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>lcdToo</em>&nbsp;</td><td>Clear LCD display too. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>- </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a11ca0493d2bdb25460fbffb5d6d96f1c"></a><!-- doxytag: member="ecrobot::Lcd::clearRow" ref="a11ca0493d2bdb25460fbffb5d6d96f1c" args="(U32 row, bool lcdToo=false)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool ecrobot::Lcd::clearRow </td>
+          <td>(</td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>row</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&nbsp;</td>
+          <td class="paramname"> <em>lcdToo</em> = <code>false</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Clear LCD data buffer at the specified row. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>row</em>&nbsp;</td><td>LCD row position to be cleared </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>lcdToo</em>&nbsp;</td><td>Clear LCD display too. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>true:succeeded/false:failed </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="aec3187f757ddc31b23b48aebf7d1bfdd"></a><!-- doxytag: member="ecrobot::Lcd::cursor" ref="aec3187f757ddc31b23b48aebf7d1bfdd" args="(U32 x, U32 y)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ecrobot::Lcd::cursor </td>
+          <td>(</td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>x</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Set cursor to (x,y) position. </p>
+<p>Top left is (0,0). </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>Cusor position in X(horizontal) axis. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>Cusor position in Y(vertical) axis. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ad56a6b9f775aae41f40979a92c8eb3e3"></a><!-- doxytag: member="ecrobot::Lcd::disp" ref="ad56a6b9f775aae41f40979a92c8eb3e3" args="(void)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ecrobot::Lcd::disp </td>
+          <td>(</td>
+          <td class="paramtype">void&nbsp;</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Display data in the LCD data buffer to the LCD. </p>
+<p>Note that LCD display takes minimun 16msec due to hardware, so frequent executions of this member function makes the system busy. </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>
+<a class="anchor" id="a3dead0edea30c23da5931eb6b830c391"></a><!-- doxytag: member="ecrobot::Lcd::draw" ref="a3dead0edea30c23da5931eb6b830c391" args="(const U8 *data, U32 width, U32 depth, U32 xPosInWidth, U32 yPosInDepth)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ecrobot::Lcd::draw </td>
+          <td>(</td>
+          <td class="paramtype">const U8 *&nbsp;</td>
+          <td class="paramname"> <em>data</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>width</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>depth</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>xPosInWidth</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">U32&nbsp;</td>
+          <td class="paramname"> <em>yPosInDepth</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Draw monochrome bit map data to the LCD data buffer. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>Monochrome bit map data which is adapted to NXT LCD data alignment </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>width</em>&nbsp;</td><td>Width of bit map data </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>depth</em>&nbsp;</td><td>Depth of bit map data </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>xPosInWidth</em>&nbsp;</td><td>X axis position of bit map data in the width unit (= 1 pixel) </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>yPosInDepth</em>&nbsp;</td><td>Y axis position of bit map data in the depth unit (= 8 pixels) </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="a03e68349ef63137aee48ece9ec7c7e4f"></a><!-- doxytag: member="ecrobot::Lcd::putf" ref="a03e68349ef63137aee48ece9ec7c7e4f" args="(const CHAR *format,...)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool ecrobot::Lcd::putf </td>
+          <td>(</td>
+          <td class="paramtype">const CHAR *&nbsp;</td>
+          <td class="paramname"> <em>format</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&nbsp;</td>
+          <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Put output to the LCD data buffer, according to format and other arguments passed to <a class="el" href="classecrobot_1_1_lcd.html#a03e68349ef63137aee48ece9ec7c7e4f" title="Put output to the LCD data buffer, according to format and other arguments passed...">putf()</a>. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>format</em>&nbsp;</td><td>Output format string.<br/>
+ "s": String format.<br/>
+ "d": Decimal integer format. This format requires two arguments (arg1: value, arg2: spaces to be held).<br/>
+ "x": Hex integer format. This format requires two arguments (arg1: value, arg2: spaces to be held).<br/>
+ "n": Line feed format. Cursor position in X(horizontal) axis is set to 0.<br/>
+ "\n": ASCII line feed format. Cursor position in X(horizontal) axis is set to 0. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>true:succeeded/false:failed(might be due to invalid format) </dd></dl>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>device/<a class="el" href="_lcd_8h_source.html">Lcd.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>