<!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>KatanaNativeInterface: CCplSerial Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">KatanaNativeInterface <span id="projectnumber">$VERSION$</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classCCplSerial.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>CCplSerial Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CCplSerial" --><!-- doxytag: inherits="CCplBase" -->
<p>Base class of two different serial protocols.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCplSerial:</div>
<div class="dyncontent">
<div class="center"><img src="classCCplSerial__inherit__graph.png" border="0" usemap="#CCplSerial_inherit__map" alt="Inheritance graph"/></div>
<map name="CCplSerial_inherit__map" id="CCplSerial_inherit__map">
<area shape="rect" id="node5" href="classCCplSerialCRC.html" title="Implement the Serial-Zero protocol." alt="" coords="5,429,160,619"/><area shape="rect" id="node2" href="classCCplBase.html" title="Abstract base class for protocol definiton." alt="" coords="5,6,160,178"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CCplSerial:</div>
<div class="dyncontent">
<div class="center"><img src="classCCplSerial__coll__graph.png" border="0" usemap="#CCplSerial_coll__map" alt="Collaboration graph"/></div>
<map name="CCplSerial_coll__map" id="CCplSerial_coll__map">
<area shape="rect" id="node2" href="classCCplBase.html" title="Abstract base class for protocol definiton." alt="" coords="5,193,160,365"/><area shape="rect" id="node4" href="classCCdlBase.html" title="Abstract base class for devices." alt="" coords="28,5,137,125"/><area shape="rect" id="node6" href="structTHeader.html" title="Header of a communication packet." alt="" coords="184,227,256,330"/><area shape="rect" id="node8" href="structTPacket.html" title="Communication packet." alt="" coords="280,227,363,330"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCCplSerial-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplSerial.html#a55bbd27e1bde075bb06eb60e75a89f0b">load_tbl</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the command table from the robot's firmware. <a href="#a55bbd27e1bde075bb06eb60e75a89f0b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplSerial.html#a9428975b706d75ae0fce04fea1dfa42c">defineProtocol</a> (<a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> _kataddr)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Defines the protocol's attributes. <a href="#a9428975b706d75ae0fce04fea1dfa42c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTHeader.html">THeader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplSerial.html#a76137628017339bc2a063967b05c02c0">hdr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">header <a href="#a76137628017339bc2a063967b05c02c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTPacket.html">TPacket</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplSerial.html#aa5d45ae4a5e2a9cc63c3ffd5c10f91c2">cmd</a> [256]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">command table <a href="#aa5d45ae4a5e2a9cc63c3ffd5c10f91c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplSerial.html#a04aaf3680d306fc8e0630cda47e267d6">send_buf</a> [256]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sending buffer <a href="#a04aaf3680d306fc8e0630cda47e267d6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplSerial.html#adab2f13f0ab3faea9235adb81a7875f7">read_buf</a> [256]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">receive buffer <a href="#adab2f13f0ab3faea9235adb81a7875f7"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class of two different serial protocols. </p>
<p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00092">92</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9428975b706d75ae0fce04fea1dfa42c"></a><!-- doxytag: member="CCplSerial::defineProtocol" ref="a9428975b706d75ae0fce04fea1dfa42c" args="(byte _kataddr)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CCplSerial::defineProtocol </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> </td>
<td class="paramname"><em>_kataddr</em></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Defines the protocol's attributes. </p>
<p>Implemented in <a class="el" href="classCCplSerialCRC.html#a3ceb64ef90b257c02d193967e52ee608">CCplSerialCRC</a>.</p>
</div>
</div>
<a class="anchor" id="a55bbd27e1bde075bb06eb60e75a89f0b"></a><!-- doxytag: member="CCplSerial::load_tbl" ref="a55bbd27e1bde075bb06eb60e75a89f0b" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CCplSerial::load_tbl </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads the command table from the robot's firmware. </p>
<p>Implemented in <a class="el" href="classCCplSerialCRC.html#ac8be1192366d072dc0b8ae7e08964bfc">CCplSerialCRC</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aa5d45ae4a5e2a9cc63c3ffd5c10f91c2"></a><!-- doxytag: member="CCplSerial::cmd" ref="aa5d45ae4a5e2a9cc63c3ffd5c10f91c2" args="[256]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTPacket.html">TPacket</a> <a class="el" href="classCCplSerial.html#aa5d45ae4a5e2a9cc63c3ffd5c10f91c2">CCplSerial::cmd</a>[256]<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>command table </p>
<p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00096">96</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="a76137628017339bc2a063967b05c02c0"></a><!-- doxytag: member="CCplSerial::hdr" ref="a76137628017339bc2a063967b05c02c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTHeader.html">THeader</a> <a class="el" href="classCCplSerial.html#a76137628017339bc2a063967b05c02c0">CCplSerial::hdr</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>header </p>
<p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00095">95</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="adab2f13f0ab3faea9235adb81a7875f7"></a><!-- doxytag: member="CCplSerial::read_buf" ref="adab2f13f0ab3faea9235adb81a7875f7" args="[256]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> <a class="el" href="classCCplSerial.html#adab2f13f0ab3faea9235adb81a7875f7">CCplSerial::read_buf</a>[256]<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>receive buffer </p>
<p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00099">99</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="a04aaf3680d306fc8e0630cda47e267d6"></a><!-- doxytag: member="CCplSerial::send_buf" ref="a04aaf3680d306fc8e0630cda47e267d6" args="[256]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> <a class="el" href="classCCplSerial.html#a04aaf3680d306fc8e0630cda47e267d6">CCplSerial::send_buf</a>[256]<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sending buffer </p>
<p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00098">98</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/KNI/<a class="el" href="cplSerial_8h_source.html">cplSerial.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classCCplSerial.html">CCplSerial</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for KatanaNativeInterface by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
