<!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: FirmwareException 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('classFirmwareException.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>FirmwareException Class Reference<div class="ingroups"><a class="el" href="group__exceptions.html">Exceptions</a></div></h1> </div> </div> <div class="contents"> <!-- doxytag: class="FirmwareException" --><!-- doxytag: inherits="Exception" --> <p><a class="el" href="classException.html">Exception</a> reported by the firmware. <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 FirmwareException:</div> <div class="dyncontent"> <div class="center"><img src="classFirmwareException__inherit__graph.png" border="0" usemap="#FirmwareException_inherit__map" alt="Inheritance graph"/></div> <map name="FirmwareException_inherit__map" id="FirmwareException_inherit__map"> <area shape="rect" id="node2" href="classException.html" title="{Exception\n|# _message\l# _error_number\l|+ Exception()\l+ ~Exception()\l+ message()\l+ what()\l+ error_number()\l}" alt="" coords="24,139,141,311"/><area shape="rect" id="node4" title="STL class." alt="" coords="31,5,135,91"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for FirmwareException:</div> <div class="dyncontent"> <div class="center"><img src="classFirmwareException__coll__graph.png" border="0" usemap="#FirmwareException_coll__map" alt="Collaboration graph"/></div> <map name="FirmwareException_coll__map" id="FirmwareException_coll__map"> <area shape="rect" id="node2" href="classException.html" title="{Exception\n|# _message\l# _error_number\l|+ Exception()\l+ ~Exception()\l+ message()\l+ what()\l+ error_number()\l}" alt="" coords="39,294,156,466"/><area shape="rect" id="node4" title="STL class." alt="" coords="5,141,109,227"/><area shape="rect" id="node6" title="STL class." alt="" coords="133,141,213,227"/><area shape="rect" id="node8" title="STL class." alt="" coords="91,5,256,91"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classFirmwareException-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="classFirmwareException.html#af01204e9c2c55258daf752a927668fce">FirmwareException</a> (const std::string &error, const int error_number, const int axis, const char command) throw ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmwareException.html#a6119a872d516b4da3483c6e8c83b1026">axis_number</a> () const throw ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmwareException.html#a43ff13414cfa427f51ee260ba39f7c29">command_char</a> () const throw ()</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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmwareException.html#af2d223cdacbab687b54ba57eb566ab26">_axis_number</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">axis number, if any <a href="#af2d223cdacbab687b54ba57eb566ab26"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classFirmwareException.html#a98cbf4ba78ddc5dd933dac51de303992">_command_char</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">the command that caused the error <a href="#a98cbf4ba78ddc5dd933dac51de303992"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p><a class="el" href="classException.html">Exception</a> reported by the firmware. </p> <p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00052">52</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="af01204e9c2c55258daf752a927668fce"></a><!-- doxytag: member="FirmwareException::FirmwareException" ref="af01204e9c2c55258daf752a927668fce" args="(const std::string &error, const int error_number, const int axis, const char command)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">FirmwareException::FirmwareException </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>error</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const int </td> <td class="paramname"><em>error_number</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const int </td> <td class="paramname"><em>axis</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char </td> <td class="paramname"><em>command</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> throw ()<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00057">57</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6119a872d516b4da3483c6e8c83b1026"></a><!-- doxytag: member="FirmwareException::axis_number" ref="a6119a872d516b4da3483c6e8c83b1026" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const int FirmwareException::axis_number </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const throw ()<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00061">61</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p> <p>References <a class="el" href="cplSerial_8h_source.html#l00054">_axis_number</a>.</p> </div> </div> <a class="anchor" id="a43ff13414cfa427f51ee260ba39f7c29"></a><!-- doxytag: member="FirmwareException::command_char" ref="a43ff13414cfa427f51ee260ba39f7c29" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char FirmwareException::command_char </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const throw ()<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00064">64</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p> <p>References <a class="el" href="cplSerial_8h_source.html#l00055">_command_char</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="af2d223cdacbab687b54ba57eb566ab26"></a><!-- doxytag: member="FirmwareException::_axis_number" ref="af2d223cdacbab687b54ba57eb566ab26" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classFirmwareException.html#af2d223cdacbab687b54ba57eb566ab26">FirmwareException::_axis_number</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>axis number, if any </p> <p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00054">54</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p> <p>Referenced by <a class="el" href="cplSerial_8h_source.html#l00061">axis_number()</a>.</p> </div> </div> <a class="anchor" id="a98cbf4ba78ddc5dd933dac51de303992"></a><!-- doxytag: member="FirmwareException::_command_char" ref="a98cbf4ba78ddc5dd933dac51de303992" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char <a class="el" href="classFirmwareException.html#a98cbf4ba78ddc5dd933dac51de303992">FirmwareException::_command_char</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>the command that caused the error </p> <p>Definition at line <a class="el" href="cplSerial_8h_source.html#l00055">55</a> of file <a class="el" href="cplSerial_8h_source.html">cplSerial.h</a>.</p> <p>Referenced by <a class="el" href="cplSerial_8h_source.html#l00064">command_char()</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="classFirmwareException.html">FirmwareException</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>