<!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: include/KNI/kmlCommon.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File 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('kmlCommon_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>kmlCommon.h</h1> </div>
</div>
<div class="contents">
<a href="kmlCommon_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// C++ Interface: kmlCommon</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Description: </span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">//</span>
<a name="l00007"></a>00007 <span class="comment">// Author: Tiziano Müller <tiziano.mueller@neuronics.ch>, (C) 2006</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// Copyright: See COPYING file that comes with this distribution</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="preprocessor">#ifndef KMLCOMMON_H</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define KMLCOMMON_H</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include "common/exception.h"</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <string></span>
<a name="l00018"></a>00018
<a name="l00019"></a><a class="code" href="kmlCommon_8h.html#ad6ffe504357959900a023228f12b10ae">00019</a> <span class="preprocessor">#define TM_ENDLESS -1 //!< timeout symbol for 'endless' waiting</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#if !defined (BYTE_DECLARED)</span>
<a name="l00022"></a><a class="code" href="kmlCommon_8h.html#a15703639675649efebe5b8aa49217f91">00022</a> <span class="preprocessor"></span><span class="preprocessor">#define BYTE_DECLARED</span>
<a name="l00023"></a><a class="code" href="kmlCommon_8h.html#a0c8186d9b9b7880309c27230bbb5e69d">00023</a> <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="cdlBase_8h.html#a0c8186d9b9b7880309c27230bbb5e69d" title="type specification (8 bit)">byte</a>;
<a name="l00024"></a>00024 <span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00035"></a><a class="code" href="classSlaveErrorException.html">00035</a> <span class="keyword">class </span><a class="code" href="classSlaveErrorException.html" title="Slave error occurred.">SlaveErrorException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00037"></a><a class="code" href="classSlaveErrorException.html#a3c62bbeed1c1efce81ecc217b9439aa4">00037</a> <a class="code" href="classSlaveErrorException.html#a3c62bbeed1c1efce81ecc217b9439aa4">SlaveErrorException</a>() throw ():
<a name="l00038"></a>00038 <a class="code" href="classException.html">Exception</a>("Internal Slave Error", -31) {}
<a name="l00039"></a>00039 };
<a name="l00040"></a>00040
<a name="l00044"></a><a class="code" href="classParameterReadingException.html">00044</a> <span class="keyword">class </span><a class="code" href="classParameterReadingException.html" title="There was an error while reading a parameter from the robot.">ParameterReadingException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a><a class="code" href="classParameterReadingException.html#a0ba5f7f6d1600784d32dc166d81c20f1">00046</a> <a class="code" href="classParameterReadingException.html#a0ba5f7f6d1600784d32dc166d81c20f1">ParameterReadingException</a>(<span class="keyword">const</span> std::string &para) <span class="keywordflow">throw</span> ():
<a name="l00047"></a>00047 <a class="code" href="classException.html#a1e7d40687c861dba563a3e0275b3cede">Exception</a>(<span class="stringliteral">"Reading '"</span> + para + <span class="stringliteral">"' parameters failed"</span>, -32) {}
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00053"></a><a class="code" href="classParameterWritingException.html">00053</a> <span class="keyword">class </span><a class="code" href="classParameterWritingException.html" title="The data you wanted to send to the robot was invalid.">ParameterWritingException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a><a class="code" href="classParameterWritingException.html#a11c9ecff57a368de20afe5a1b7c198e6">00055</a> <a class="code" href="classParameterWritingException.html#a11c9ecff57a368de20afe5a1b7c198e6">ParameterWritingException</a>(<span class="keyword">const</span> std::string &para) <span class="keywordflow">throw</span> ():
<a name="l00056"></a>00056 <a class="code" href="classException.html#a1e7d40687c861dba563a3e0275b3cede">Exception</a>(<span class="stringliteral">"Writing '"</span> + para + <span class="stringliteral">"' parameters failed"</span>, -33) {}
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058
<a name="l00062"></a><a class="code" href="classWrongParameterException.html">00062</a> <span class="keyword">class </span><a class="code" href="classWrongParameterException.html" title="The given parameter was wrong.">WrongParameterException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00063"></a>00063 <span class="keyword">public</span>:
<a name="l00064"></a><a class="code" href="classWrongParameterException.html#a80d01cc3e2fd2bed78c276e4f8432823">00064</a> <a class="code" href="classWrongParameterException.html#a80d01cc3e2fd2bed78c276e4f8432823">WrongParameterException</a>(<span class="keyword">const</span> std::string &para) <span class="keywordflow">throw</span> ():
<a name="l00065"></a>00065 <a class="code" href="classException.html#a1e7d40687c861dba563a3e0275b3cede">Exception</a>(<span class="stringliteral">"Wrong parameters '"</span> + para + <span class="stringliteral">"' set"</span>, -34) {}
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067
<a name="l00071"></a><a class="code" href="classMotorOutOfRangeException.html">00071</a> <span class="keyword">class </span><a class="code" href="classMotorOutOfRangeException.html" title="The encoders for the given motor were out of range.">MotorOutOfRangeException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00072"></a>00072 <span class="keyword">public</span>:
<a name="l00073"></a><a class="code" href="classMotorOutOfRangeException.html#a7fb8279d22a15bf9a10867d9219974e4">00073</a> <a class="code" href="classMotorOutOfRangeException.html#a7fb8279d22a15bf9a10867d9219974e4">MotorOutOfRangeException</a>() throw ():
<a name="l00074"></a>00074 <a class="code" href="classException.html">Exception</a>("Encoders for motor are out of range", -35) {}
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076
<a name="l00080"></a><a class="code" href="classMotorTimeoutException.html">00080</a> <span class="keyword">class </span><a class="code" href="classMotorTimeoutException.html" title="The timeout elapsed for the given motor and target position.">MotorTimeoutException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00081"></a>00081 <span class="keyword">public</span>:
<a name="l00082"></a><a class="code" href="classMotorTimeoutException.html#a5a8642951032c60d719382b2f12a665c">00082</a> <a class="code" href="classMotorTimeoutException.html#a5a8642951032c60d719382b2f12a665c">MotorTimeoutException</a>() throw ():
<a name="l00083"></a>00083 <a class="code" href="classException.html">Exception</a>("Motor timeout", -36) {}
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085
<a name="l00089"></a><a class="code" href="classMotorCrashException.html">00089</a> <span class="keyword">class </span><a class="code" href="classMotorCrashException.html" title="The requested motor crashed during the movement.">MotorCrashException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a> {
<a name="l00090"></a>00090 <span class="keyword">public</span>:
<a name="l00091"></a><a class="code" href="classMotorCrashException.html#a381b18da8f4000bc6b95a4bf6c39cf3a">00091</a> <a class="code" href="classMotorCrashException.html#a381b18da8f4000bc6b95a4bf6c39cf3a">MotorCrashException</a>() throw ():
<a name="l00092"></a>00092 <a class="code" href="classException.html">Exception</a>("Motor crashed", -37) {}
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00100"></a>00100
<a name="l00101"></a>00101
<a name="l00102"></a>00102
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="kmlCommon_8h.html">kmlCommon.h</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>
