<!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: CCplBase 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('classCCplBase.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>CCplBase Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CCplBase" -->
<p>Abstract base class for protocol definiton.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cplBase_8h_source.html">cplBase.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCplBase:</div>
<div class="dyncontent">
<div class="center"><img src="classCCplBase__inherit__graph.png" border="0" usemap="#CCplBase_inherit__map" alt="Inheritance graph"/></div>
<map name="CCplBase_inherit__map" id="CCplBase_inherit__map">
<area shape="rect" id="node3" href="classCCplSerial.html" title="Base class of two different serial protocols." alt="" coords="21,227,144,381"/><area shape="rect" id="node5" href="classCCplSerialCRC.html" title="Implement the Serial-Zero protocol." alt="" coords="5,429,160,619"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CCplBase:</div>
<div class="dyncontent">
<div class="center"><img src="classCCplBase__coll__graph.png" border="0" usemap="#CCplBase_coll__map" alt="Collaboration graph"/></div>
<map name="CCplBase_coll__map" id="CCplBase_coll__map">
<area shape="rect" id="node2" href="classCCdlBase.html" title="Abstract base class for devices." alt="" coords="28,5,137,125"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCCplBase-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public 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="classCCplBase.html#af552a1fecb58819245c930cb0de05211">init</a> (<a class="el" href="classCCdlBase.html">CCdlBase</a> *_device, <a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> _kataddr=24)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic initializing function. <a href="#af552a1fecb58819245c930cb0de05211"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplBase.html#a8f96d7f7bc108dee3e99b028b02b2af2">comm</a> (const <a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> *pack, <a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> *buf, <a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> *size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base communication function. <a href="#a8f96d7f7bc108dee3e99b028b02b2af2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplBase.html#aef21aea904249c5abfb42bd36104b7ef">~CCplBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#aef21aea904249c5abfb42bd36104b7ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplBase.html#a4920c0b9c8312ab80bb1fc39a4d54f25">getMasterFirmware</a> (short *fw, short *rev)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the master firmware of the robot we are communicating with. <a href="#a4920c0b9c8312ab80bb1fc39a4d54f25"></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="classCCdlBase.html">CCdlBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplBase.html#ab2bdbdb92aff57328fe0c7a820967f21">device</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">communication device <a href="#ab2bdbdb92aff57328fe0c7a820967f21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplBase.html#a2b0c82d7be03404d9a535bc95d77b7fb">mMasterVersion</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">master version of robot we are communicating with <a href="#a2b0c82d7be03404d9a535bc95d77b7fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCplBase.html#a4d35345c97ece7876b80c0e4329dbd47">mMasterRevision</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">master firmware revision <a href="#a4d35345c97ece7876b80c0e4329dbd47"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class for protocol definiton. </p>
<p>The robot can be controled by using different kind of protocols; this class has been introduced as an abstract base class to manage them gether; every protocol the robot should use in futur shoud be derived from this class. </p>
<p>Definition at line <a class="el" href="cplBase_8h_source.html#l00047">47</a> of file <a class="el" href="cplBase_8h_source.html">cplBase.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aef21aea904249c5abfb42bd36104b7ef"></a><!-- doxytag: member="CCplBase::~CCplBase" ref="aef21aea904249c5abfb42bd36104b7ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CCplBase::~CCplBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>destructor </p>
<p>This class is only an interface </p>
<p>Definition at line <a class="el" href="cplBase_8h_source.html#l00075">75</a> of file <a class="el" href="cplBase_8h_source.html">cplBase.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8f96d7f7bc108dee3e99b028b02b2af2"></a><!-- doxytag: member="CCplBase::comm" ref="a8f96d7f7bc108dee3e99b028b02b2af2" args="(const byte *pack, byte *buf, byte *size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CCplBase::comm </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> * </td>
<td class="paramname"><em>pack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> * </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Base communication function. </p>
<p>The children of this class should write their main double way communication in this function. </p>
<p>Implemented in <a class="el" href="classCCplSerialCRC.html#ab71bec739257750214103bfd9067e03d">CCplSerialCRC</a>.</p>
</div>
</div>
<a class="anchor" id="a4920c0b9c8312ab80bb1fc39a4d54f25"></a><!-- doxytag: member="CCplBase::getMasterFirmware" ref="a4920c0b9c8312ab80bb1fc39a4d54f25" args="(short *fw, short *rev)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CCplBase::getMasterFirmware </td>
<td>(</td>
<td class="paramtype">short * </td>
<td class="paramname"><em>fw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short * </td>
<td class="paramname"><em>rev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the master firmware of the robot we are communicating with. </p>
<p>Get master firmware read at initialization time. </p>
<p>Implemented in <a class="el" href="classCCplSerialCRC.html#a955ccdcd9ee9a1b8519b85ab2700c9ed">CCplSerialCRC</a>.</p>
</div>
</div>
<a class="anchor" id="af552a1fecb58819245c930cb0de05211"></a><!-- doxytag: member="CCplBase::init" ref="af552a1fecb58819245c930cb0de05211" args="(CCdlBase *_device, byte _kataddr=24)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CCplBase::init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCCdlBase.html">CCdlBase</a> * </td>
<td class="paramname"><em>_device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">byte</a> </td>
<td class="paramname"><em>_kataddr</em> = <code>24</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Basic initializing function. </p>
<p>The children of this class should write their initializing part in that function. </p>
<p>Implemented in <a class="el" href="classCCplSerialCRC.html#a6a8106a8071a904892aec70d7dc59ed8">CCplSerialCRC</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab2bdbdb92aff57328fe0c7a820967f21"></a><!-- doxytag: member="CCplBase::device" ref="ab2bdbdb92aff57328fe0c7a820967f21" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCCdlBase.html">CCdlBase</a>* <a class="el" href="classCCplBase.html#ab2bdbdb92aff57328fe0c7a820967f21">CCplBase::device</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>communication device </p>
<p>Definition at line <a class="el" href="cplBase_8h_source.html#l00050">50</a> of file <a class="el" href="cplBase_8h_source.html">cplBase.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4d35345c97ece7876b80c0e4329dbd47"></a><!-- doxytag: member="CCplBase::mMasterRevision" ref="a4d35345c97ece7876b80c0e4329dbd47" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short <a class="el" href="classCCplBase.html#a4d35345c97ece7876b80c0e4329dbd47">CCplBase::mMasterRevision</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>master firmware revision </p>
<p>Definition at line <a class="el" href="cplBase_8h_source.html#l00052">52</a> of file <a class="el" href="cplBase_8h_source.html">cplBase.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2b0c82d7be03404d9a535bc95d77b7fb"></a><!-- doxytag: member="CCplBase::mMasterVersion" ref="a2b0c82d7be03404d9a535bc95d77b7fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short <a class="el" href="classCCplBase.html#a2b0c82d7be03404d9a535bc95d77b7fb">CCplBase::mMasterVersion</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>master version of robot we are communicating with </p>
<p>Definition at line <a class="el" href="cplBase_8h_source.html#l00051">51</a> of file <a class="el" href="cplBase_8h_source.html">cplBase.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="cplBase_8h_source.html">cplBase.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classCCplBase.html">CCplBase</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>
