Mercurial Mercurial > canfestival / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
doc/doxygen/html/classcan__uvccm__win32.html
changeset 207 b6572d0336c3 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/doxygen/html/classcan__uvccm__win32.html	Mon Jun 04 17:59:50 2007 +0200
@@ -0,0 +1,358 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>CanFestival: can_uvccm_win32 Class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.1 -->
+<div class="tabs">
+  <ul>
+    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</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>Data&nbsp;Structures</span></a></li>
+    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
+  </ul></div>
+<h1>can_uvccm_win32 Class Reference</h1><!-- doxytag: class="can_uvccm_win32" --><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#f4f6d1f25174fd3b7d897a5f73bc363e">can_uvccm_win32</a> (<a class="el" href="structstruct__s__BOARD.html">s_BOARD</a> *board)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#39bb5c7bb141391d0f2f34b7dd5f487c">~can_uvccm_win32</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#3358bfa32c0164bc11d220745e3e0430">send</a> (const <a class="el" href="structMessage.html">Message</a> *m)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#4301393c1d3046b35d0b545e761b94db">receive</a> (<a class="el" href="structMessage.html">Message</a> *m)</td></tr>
+
+<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#7fb6732edc691451bc1d3206c07d4715">open_rs232</a> (int port=1, int baud_rate=57600)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#06f9d2fb860a821436471c3233f91dff">close_rs232</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#c3d1d02a46518b2639beb6060f79f2a2">get_can_data</a> (const char *can_cmd_buf, long &amp;bufsize, <a class="el" href="structMessage.html">Message</a> *m)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#0f2aed9c45f29e6082f37ea17aea46ae">set_can_data</a> (const <a class="el" href="structMessage.html">Message</a> &amp;m, std::string &amp;can_cmd)</td></tr>
+
+<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HANDLE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#3f13c1748b3cd57fd1d478782428859a">m_port</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HANDLE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#cf25e6725871137696ab41b06fa05417">m_read_event</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">HANDLE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#544ea7fd0e8a5d7cfb7cf9058d6020a4">m_write_event</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32.html#d264855657adc02fbc687f37d302fc9f">m_residual_buffer</a></td></tr>
+
+<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcan__uvccm__win32_1_1error.html">error</a></td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00017">17</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="f4f6d1f25174fd3b7d897a5f73bc363e"></a><!-- doxytag: member="can_uvccm_win32::can_uvccm_win32" ref="f4f6d1f25174fd3b7d897a5f73bc363e" args="(s_BOARD *board)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">can_uvccm_win32::can_uvccm_win32           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structstruct__s__BOARD.html">s_BOARD</a> *&nbsp;</td>
+          <td class="paramname"> <em>board</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00039">39</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="can__driver_8h-source.html#l00035">struct_s_BOARD::baudrate</a>, and <a class="el" href="can__uvccm__win32_8cpp-source.html#l00136">open_rs232()</a>.
+</div>
+</div><p>
+<a class="anchor" name="39bb5c7bb141391d0f2f34b7dd5f487c"></a><!-- doxytag: member="can_uvccm_win32::~can_uvccm_win32" ref="39bb5c7bb141391d0f2f34b7dd5f487c" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">can_uvccm_win32::~can_uvccm_win32           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00047">47</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="can__uvccm__win32_8cpp-source.html#l00190">close_rs232()</a>.
+</div>
+</div><p>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="3358bfa32c0164bc11d220745e3e0430"></a><!-- doxytag: member="can_uvccm_win32::send" ref="3358bfa32c0164bc11d220745e3e0430" args="(const Message *m)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool can_uvccm_win32::send           </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
+          <td class="paramname"> <em>m</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00052">52</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="def_8h-source.html#l00063">FALSE</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00033">m_port</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00035">m_write_event</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00271">set_can_data()</a>, and <a class="el" href="eds__utils_8py-source.html#l00391">eds_utils::WriteFile()</a>.
+</div>
+</div><p>
+<a class="anchor" name="4301393c1d3046b35d0b545e761b94db"></a><!-- doxytag: member="can_uvccm_win32::receive" ref="4301393c1d3046b35d0b545e761b94db" args="(Message *m)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool can_uvccm_win32::receive           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
+          <td class="paramname"> <em>m</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00080">80</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="def_8h-source.html#l00063">FALSE</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00206">get_can_data()</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00033">m_port</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00034">m_read_event</a>, and <a class="el" href="can__uvccm__win32_8cpp-source.html#l00036">m_residual_buffer</a>.
+</div>
+</div><p>
+<a class="anchor" name="7fb6732edc691451bc1d3206c07d4715"></a><!-- doxytag: member="can_uvccm_win32::open_rs232" ref="7fb6732edc691451bc1d3206c07d4715" args="(int port=1, int baud_rate=57600)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool can_uvccm_win32::open_rs232           </td>
+          <td>(</td>
+          <td class="paramtype">int&nbsp;</td>
+          <td class="paramname"> <em>port</em> = <code>1</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&nbsp;</td>
+          <td class="paramname"> <em>baud_rate</em> = <code>57600</code></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00136">136</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="def_8h-source.html#l00063">FALSE</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00033">m_port</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00034">m_read_event</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00035">m_write_event</a>, and <a class="el" href="def_8h-source.html#l00062">TRUE</a>.
+</div>
+</div><p>
+<a class="anchor" name="06f9d2fb860a821436471c3233f91dff"></a><!-- doxytag: member="can_uvccm_win32::close_rs232" ref="06f9d2fb860a821436471c3233f91dff" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool can_uvccm_win32::close_rs232           </td>
+          <td>(</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00190">190</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="can__uvccm__win32_8cpp-source.html#l00033">m_port</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00034">m_read_event</a>, <a class="el" href="can__uvccm__win32_8cpp-source.html#l00036">m_residual_buffer</a>, and <a class="el" href="can__uvccm__win32_8cpp-source.html#l00035">m_write_event</a>.
+</div>
+</div><p>
+<a class="anchor" name="c3d1d02a46518b2639beb6060f79f2a2"></a><!-- doxytag: member="can_uvccm_win32::get_can_data" ref="c3d1d02a46518b2639beb6060f79f2a2" args="(const char *can_cmd_buf, long &amp;bufsize, Message *m)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool can_uvccm_win32::get_can_data           </td>
+          <td>(</td>
+          <td class="paramtype">const char *&nbsp;</td>
+          <td class="paramname"> <em>can_cmd_buf</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">long &amp;&nbsp;</td>
+          <td class="paramname"> <em>bufsize</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
+          <td class="paramname"> <em>m</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00206">206</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="can_8h-source.html#l00042">Message::cob_id</a>, <a class="el" href="can_8h-source.html#l00046">Message::data</a>, <a class="el" href="can_8h-source.html#l00045">Message::len</a>, <a class="el" href="can_8h-source.html#l00043">Message::rtr</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00139">UNS8</a>, and <a class="el" href="can_8h-source.html#l00036">SHORT_CAN::w</a>.
+</div>
+</div><p>
+<a class="anchor" name="0f2aed9c45f29e6082f37ea17aea46ae"></a><!-- doxytag: member="can_uvccm_win32::set_can_data" ref="0f2aed9c45f29e6082f37ea17aea46ae" args="(const Message &amp;m, std::string &amp;can_cmd)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool can_uvccm_win32::set_can_data           </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> &amp;&nbsp;</td>
+          <td class="paramname"> <em>m</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">std::string &amp;&nbsp;</td>
+          <td class="paramname"> <em>can_cmd</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"><code> [private]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00271">271</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+<p>
+References <a class="el" href="can_8h-source.html#l00042">Message::cob_id</a>, <a class="el" href="can_8h-source.html#l00046">Message::data</a>, <a class="el" href="can_8h-source.html#l00045">Message::len</a>, <a class="el" href="can_8h-source.html#l00043">Message::rtr</a>, and <a class="el" href="can_8h-source.html#l00036">SHORT_CAN::w</a>.
+</div>
+</div><p>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="3f13c1748b3cd57fd1d478782428859a"></a><!-- doxytag: member="can_uvccm_win32::m_port" ref="3f13c1748b3cd57fd1d478782428859a" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HANDLE <a class="el" href="classcan__uvccm__win32.html#3f13c1748b3cd57fd1d478782428859a">can_uvccm_win32::m_port</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00033">33</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+</div>
+</div><p>
+<a class="anchor" name="cf25e6725871137696ab41b06fa05417"></a><!-- doxytag: member="can_uvccm_win32::m_read_event" ref="cf25e6725871137696ab41b06fa05417" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HANDLE <a class="el" href="classcan__uvccm__win32.html#cf25e6725871137696ab41b06fa05417">can_uvccm_win32::m_read_event</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00034">34</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+</div>
+</div><p>
+<a class="anchor" name="544ea7fd0e8a5d7cfb7cf9058d6020a4"></a><!-- doxytag: member="can_uvccm_win32::m_write_event" ref="544ea7fd0e8a5d7cfb7cf9058d6020a4" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">HANDLE <a class="el" href="classcan__uvccm__win32.html#544ea7fd0e8a5d7cfb7cf9058d6020a4">can_uvccm_win32::m_write_event</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00035">35</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+</div>
+</div><p>
+<a class="anchor" name="d264855657adc02fbc687f37d302fc9f"></a><!-- doxytag: member="can_uvccm_win32::m_residual_buffer" ref="d264855657adc02fbc687f37d302fc9f" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::string <a class="el" href="classcan__uvccm__win32.html#d264855657adc02fbc687f37d302fc9f">can_uvccm_win32::m_residual_buffer</a><code> [private]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+Definition at line <a class="el" href="can__uvccm__win32_8cpp-source.html#l00036">36</a> of file <a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a>.
+</div>
+</div><p>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li>/home/epimerde/documents/tc11/CanFestival-3/drivers/can_uvccm_win32/<a class="el" href="can__uvccm__win32_8cpp-source.html">can_uvccm_win32.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 4 16:29:08 2007 for CanFestival by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
+</body>
+</html>
canfestival