<!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: CCdlCOM 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('classCCdlCOM.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>CCdlCOM Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CCdlCOM" --><!-- doxytag: inherits="CCdlBase" -->
<p>Encapsulates the serial port device.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cdlCOM_8h_source.html">cdlCOM.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CCdlCOM:</div>
<div class="dyncontent">
<div class="center"><img src="classCCdlCOM__inherit__graph.png" border="0" usemap="#CCdlCOM_inherit__map" alt="Inheritance graph"/></div>
<map name="CCdlCOM_inherit__map" id="CCdlCOM_inherit__map">
<area shape="rect" id="node2" href="classCCdlBase.html" title="Abstract base class for devices." alt="" coords="5,5,115,125"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CCdlCOM:</div>
<div class="dyncontent">
<div class="center"><img src="classCCdlCOM__coll__graph.png" border="0" usemap="#CCdlCOM_coll__map" alt="Collaboration graph"/></div>
<map name="CCdlCOM_coll__map" id="CCdlCOM_coll__map">
<area shape="rect" id="node2" href="classCCdlBase.html" title="Abstract base class for devices." alt="" coords="5,176,115,296"/><area shape="rect" id="node4" href="structTCdlCOMDesc.html" title="This structrue stores the attributes for a serial port device." alt="" coords="139,141,251,331"/><area shape="rect" id="node6" title="STL class." alt="" coords="275,193,355,279"/><area shape="rect" id="node8" title="STL class." alt="" coords="232,5,397,91"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCCdlCOM-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#ad32aab70e5b768801ad16f3995c3fe35">CCdlCOM</a> (<a class="el" href="structTCdlCOMDesc.html">TCdlCOMDesc</a> ccd, const char *dev_name=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classCCdlCOM.html" title="Encapsulates the serial port device.">CCdlCOM</a> class. <a href="#ad32aab70e5b768801ad16f3995c3fe35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#ade791ed9d1f26483eb88243df0075639">~CCdlCOM</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructs the class. <a href="#ade791ed9d1f26483eb88243df0075639"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#af7c7978c1f0d485581c70f965812edd8">send</a> (const void *buf, int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends data to the device. <a href="#af7c7978c1f0d485581c70f965812edd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#ad95410fbca40a7cc47e56d5d4babdeaa">recv</a> (void *buf, int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receives data from the device. <a href="#ad95410fbca40a7cc47e56d5d4babdeaa"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#ad20ba3d618b0d3e7a214737356a4d1a2">digit</a> (const int _val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts an integer to a char. <a href="#ad20ba3d618b0d3e7a214737356a4d1a2"></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="structTCdlCOMDesc.html">TCdlCOMDesc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#a2ba7a1b0df4f2aad1170b6f654b85615">_ccd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stores the attributes of the serial port device. <a href="#a2ba7a1b0df4f2aad1170b6f654b85615"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#a4b04577f1111563a2569597b10c24817">_prtHdl</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">port handle <a href="#a4b04577f1111563a2569597b10c24817"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct termios </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#aeb67f140122b54d5fdcb591fda17f487">_oto</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">old timeouts <a href="#aeb67f140122b54d5fdcb591fda17f487"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCCdlCOM.html#ad8af234398ca7899d90ecfb6e27a468c">_deviceName</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Encapsulates the serial port device. </p>
<p>This class is responsible for direct communication with the serial port device. It builds the lowest layer for communication and uses the system API functions to get access the to the device. </p>
<p>Definition at line <a class="el" href="cdlCOM_8h_source.html#l00073">73</a> of file <a class="el" href="cdlCOM_8h_source.html">cdlCOM.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad32aab70e5b768801ad16f3995c3fe35"></a><!-- doxytag: member="CCdlCOM::CCdlCOM" ref="ad32aab70e5b768801ad16f3995c3fe35" args="(TCdlCOMDesc ccd, const char *dev_name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCdlCOM::CCdlCOM </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structTCdlCOMDesc.html">TCdlCOMDesc</a> </td>
<td class="paramname"><em>ccd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dev_name</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classCCdlCOM.html" title="Encapsulates the serial port device.">CCdlCOM</a> class. </p>
<p>To this constructor a 'TCdlCOMDesc' parameter has to be given, which describes the desired serial port. An attempt to open a connection to the desired device will be tried. </p>
</div>
</div>
<a class="anchor" id="ade791ed9d1f26483eb88243df0075639"></a><!-- doxytag: member="CCdlCOM::~CCdlCOM" ref="ade791ed9d1f26483eb88243df0075639" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CCdlCOM::~CCdlCOM </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructs the class. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad20ba3d618b0d3e7a214737356a4d1a2"></a><!-- doxytag: member="CCdlCOM::digit" ref="ad20ba3d618b0d3e7a214737356a4d1a2" args="(const int _val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static char CCdlCOM::digit </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>_val</em></td><td>)</td>
<td><code> [inline, static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts an integer to a char. </p>
<p>Definition at line <a class="el" href="cdlCOM_8h_source.html#l00099">99</a> of file <a class="el" href="cdlCOM_8h_source.html">cdlCOM.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad95410fbca40a7cc47e56d5d4babdeaa"></a><!-- doxytag: member="CCdlCOM::recv" ref="ad95410fbca40a7cc47e56d5d4babdeaa" args="(void *buf, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CCdlCOM::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>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives data from the device. </p>
<p>Implements <a class="el" href="classCCdlBase.html#a206a79ca60593b62676f2ef3a8b157a1">CCdlBase</a>.</p>
</div>
</div>
<a class="anchor" id="af7c7978c1f0d485581c70f965812edd8"></a><!-- doxytag: member="CCdlCOM::send" ref="af7c7978c1f0d485581c70f965812edd8" args="(const void *buf, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CCdlCOM::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>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends data to the device. </p>
<p>Implements <a class="el" href="classCCdlBase.html#aba5536b5780002dfd20884b79d38f172">CCdlBase</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2ba7a1b0df4f2aad1170b6f654b85615"></a><!-- doxytag: member="CCdlCOM::_ccd" ref="a2ba7a1b0df4f2aad1170b6f654b85615" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTCdlCOMDesc.html">TCdlCOMDesc</a> <a class="el" href="classCCdlCOM.html#a2ba7a1b0df4f2aad1170b6f654b85615">CCdlCOM::_ccd</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores the attributes of the serial port device. </p>
<p>Definition at line <a class="el" href="cdlCOM_8h_source.html#l00079">79</a> of file <a class="el" href="cdlCOM_8h_source.html">cdlCOM.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad8af234398ca7899d90ecfb6e27a468c"></a><!-- doxytag: member="CCdlCOM::_deviceName" ref="ad8af234398ca7899d90ecfb6e27a468c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classCCdlCOM.html#ad8af234398ca7899d90ecfb6e27a468c">CCdlCOM::_deviceName</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="cdlCOM_8h_source.html#l00075">75</a> of file <a class="el" href="cdlCOM_8h_source.html">cdlCOM.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeb67f140122b54d5fdcb591fda17f487"></a><!-- doxytag: member="CCdlCOM::_oto" ref="aeb67f140122b54d5fdcb591fda17f487" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct termios <a class="el" href="classCCdlCOM.html#aeb67f140122b54d5fdcb591fda17f487">CCdlCOM::_oto</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>old timeouts </p>
<p>Definition at line <a class="el" href="cdlCOM_8h_source.html#l00090">90</a> of file <a class="el" href="cdlCOM_8h_source.html">cdlCOM.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4b04577f1111563a2569597b10c24817"></a><!-- doxytag: member="CCdlCOM::_prtHdl" ref="a4b04577f1111563a2569597b10c24817" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classCCdlCOM.html#a4b04577f1111563a2569597b10c24817">CCdlCOM::_prtHdl</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>port handle </p>
<p>Definition at line <a class="el" href="cdlCOM_8h_source.html#l00089">89</a> of file <a class="el" href="cdlCOM_8h_source.html">cdlCOM.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="cdlCOM_8h_source.html">cdlCOM.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classCCdlCOM.html">CCdlCOM</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>
