<!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: CCdlBase 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('classCCdlBase.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <h1>CCdlBase Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="CCdlBase" --> <p>Abstract base class for devices. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="cdlBase_8h_source.html">cdlBase.h</a>></code></p> <div class="dynheader"> Inheritance diagram for CCdlBase:</div> <div class="dyncontent"> <div class="center"><img src="classCCdlBase__inherit__graph.png" border="0" usemap="#CCdlBase_inherit__map" alt="Inheritance graph"/></div> <map name="CCdlBase_inherit__map" id="CCdlBase_inherit__map"> <area shape="rect" id="node3" href="classCCdlCOM.html" title="Encapsulates the serial port device." alt="" coords="5,191,115,398"/><area shape="rect" id="node5" href="classCCdlSocket.html" title="Encapsulates the socket communication device." alt="" coords="139,174,259,415"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classCCdlBase-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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlBase.html#aba5536b5780002dfd20884b79d38f172">send</a> (const void *_buf, int _sz)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Pure function to send data. <a href="#aba5536b5780002dfd20884b79d38f172"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlBase.html#a206a79ca60593b62676f2ef3a8b157a1">recv</a> (void *_buf, int _sz)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Pure function to receive data. <a href="#a206a79ca60593b62676f2ef3a8b157a1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlBase.html#ad112f5efdeb5f756aacd36bf21f263ed">~CCdlBase</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#ad112f5efdeb5f756aacd36bf21f263ed"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Abstract base class for devices. </p> <p>This class is the base abstract class for devices; the abbreviation 'cdl' stands for 'Communication Device Layer'. By inheriting from this class different communication devices such a USB or a COM port can be handled easier. </p> <p>Definition at line <a class="el" href="cdlBase_8h_source.html#l00047">47</a> of file <a class="el" href="cdlBase_8h_source.html">cdlBase.h</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ad112f5efdeb5f756aacd36bf21f263ed"></a><!-- doxytag: member="CCdlBase::~CCdlBase" ref="ad112f5efdeb5f756aacd36bf21f263ed" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual CCdlBase::~CCdlBase </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="cdlBase_8h_source.html#l00069">69</a> of file <a class="el" href="cdlBase_8h_source.html">cdlBase.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a206a79ca60593b62676f2ef3a8b157a1"></a><!-- doxytag: member="CCdlBase::recv" ref="a206a79ca60593b62676f2ef3a8b157a1" args="(void *_buf, int _sz)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int CCdlBase::recv </td> <td>(</td> <td class="paramtype">void * </td> <td class="paramname"><em>_buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>_sz</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Pure function to receive data. </p> <p>This function is pure and should always be overwritten by classes in- heriting from 'CCdlBase'. As the name proposes the function should contain a sending behavour from the device. </p> <p>Implemented in <a class="el" href="classCCdlCOM.html#ad95410fbca40a7cc47e56d5d4babdeaa">CCdlCOM</a>, and <a class="el" href="classCCdlSocket.html#a14856fd7eb9603e241b1e7a234493d21">CCdlSocket</a>.</p> </div> </div> <a class="anchor" id="aba5536b5780002dfd20884b79d38f172"></a><!-- doxytag: member="CCdlBase::send" ref="aba5536b5780002dfd20884b79d38f172" args="(const void *_buf, int _sz)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int CCdlBase::send </td> <td>(</td> <td class="paramtype">const void * </td> <td class="paramname"><em>_buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>_sz</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Pure function to send data. </p> <p>This function is pure and should always be overwritten by classes inheriting from 'CCdlBase'. As the name proposes the function should contain a sending behavour from the device. </p> <p>Implemented in <a class="el" href="classCCdlCOM.html#af7c7978c1f0d485581c70f965812edd8">CCdlCOM</a>, and <a class="el" href="classCCdlSocket.html#aa94e3a9baad4da7ffeba8c1ede8ba552">CCdlSocket</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>include/KNI/<a class="el" href="cdlBase_8h_source.html">cdlBase.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classCCdlBase.html">CCdlBase</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>