<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>PolyBoRi: polybori::PBoRiError Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacepolybori.html">polybori</a>::<a class="el" href="classpolybori_1_1PBoRiError.html">PBoRiError</a> </div> </div> <div class="contents"> <h1>polybori::PBoRiError Class Reference</h1><!-- doxytag: class="polybori::PBoRiError" -->This class is used for polybori's exception handling. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="PBoRiError_8h_source.html">PBoRiError.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for polybori::PBoRiError:</div> <div class="dynsection"> <p><center><img src="classpolybori_1_1PBoRiError.png" usemap="#polybori::PBoRiError_map" border="0" alt=""></center> <map name="polybori::PBoRiError_map"> <area href="classpolybori_1_1PBoRiGenericError.html" alt="polybori::PBoRiGenericError< ErrorCode >" shape="rect" coords="0,56,257,80"> </map> </div> <p> <a href="classpolybori_1_1PBoRiError-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#3833bacefff1e7ccd8b44ac77b43f626">CTypes::errornum_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">errornum_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">adopt global error code enumeration <a href="#95dfedddd52dc15b61f99b197ea614a5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#4a2cdc40729c10c4cb53a98270c93129">CTypes::errortext_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#603483e031f76b4859afe89555eeb6c4">errortext_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">adopt global error text type <a href="#603483e031f76b4859afe89555eeb6c4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classpolybori_1_1PBoRiError.html">PBoRiError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#35adeacefba7b3918e6e7083047f5767">self</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generic access to type of <code>*this</code> <a href="#35adeacefba7b3918e6e7083047f5767"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#a13b52115242286c11f5b248c68cd8b9">PBoRiError</a> (<a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">errornum_type</a> err=CTypes::alright)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">construct instance from error code <a href="#a13b52115242286c11f5b248c68cd8b9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#e369e4ef61a2e6d415d7229f9b7d7f47">PBoRiError</a> (const <a class="el" href="classpolybori_1_1PBoRiError.html">self</a> &)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <a href="#e369e4ef61a2e6d415d7229f9b7d7f47"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#b43e2f69698e1c41856a1ab7d18eec29">~PBoRiError</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#b43e2f69698e1c41856a1ab7d18eec29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">errornum_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#9403bd5831ffef32d90440695fb63236">code</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get error code <a href="#9403bd5831ffef32d90440695fb63236"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classpolybori_1_1PBoRiError.html#603483e031f76b4859afe89555eeb6c4">errortext_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#8f8c4d0b81f31d54bcc6523375e90bd5">text</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get error text <a href="#8f8c4d0b81f31d54bcc6523375e90bd5"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">errornum_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1PBoRiError.html#8196410694524ab5624d3dc480f7c722">error</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This class is used for polybori's exception handling. <p> It's mainly a class wrapper for CTypes::errorcode. <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="95dfedddd52dc15b61f99b197ea614a5"></a><!-- doxytag: member="polybori::PBoRiError::errornum_type" ref="95dfedddd52dc15b61f99b197ea614a5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#3833bacefff1e7ccd8b44ac77b43f626">CTypes::errornum_type</a> <a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">polybori::PBoRiError::errornum_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> adopt global error code enumeration <p> <p>Reimplemented in <a class="el" href="classpolybori_1_1PBoRiGenericError.html#91bc661d475c1ac63091ec8b2f666a44">polybori::PBoRiGenericError< ErrorCode ></a>.</p> </div> </div><p> <a class="anchor" name="603483e031f76b4859afe89555eeb6c4"></a><!-- doxytag: member="polybori::PBoRiError::errortext_type" ref="603483e031f76b4859afe89555eeb6c4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#4a2cdc40729c10c4cb53a98270c93129">CTypes::errortext_type</a> <a class="el" href="classpolybori_1_1PBoRiError.html#603483e031f76b4859afe89555eeb6c4">polybori::PBoRiError::errortext_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> adopt global error text type <p> <p>Reimplemented in <a class="el" href="classpolybori_1_1PBoRiGenericError.html#a03de73ea7da962fa8dee63616557320">polybori::PBoRiGenericError< ErrorCode ></a>.</p> </div> </div><p> <a class="anchor" name="35adeacefba7b3918e6e7083047f5767"></a><!-- doxytag: member="polybori::PBoRiError::self" ref="35adeacefba7b3918e6e7083047f5767" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="classpolybori_1_1PBoRiError.html">PBoRiError</a> <a class="el" href="classpolybori_1_1PBoRiError.html">polybori::PBoRiError::self</a> </td> </tr> </table> </div> <div class="memdoc"> <p> generic access to type of <code>*this</code> <p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a13b52115242286c11f5b248c68cd8b9"></a><!-- doxytag: member="polybori::PBoRiError::PBoRiError" ref="a13b52115242286c11f5b248c68cd8b9" args="(errornum_type err=CTypes::alright)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">polybori::PBoRiError::PBoRiError </td> <td>(</td> <td class="paramtype"><a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">errornum_type</a> </td> <td class="paramname"> <em>err</em> = <code>CTypes::alright</code> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> construct instance from error code <p> <p>References <a class="el" href="pbori__defs_8h_source.html#l00226">PBORI_TRACE_FUNC</a>.</p> </div> </div><p> <a class="anchor" name="e369e4ef61a2e6d415d7229f9b7d7f47"></a><!-- doxytag: member="polybori::PBoRiError::PBoRiError" ref="e369e4ef61a2e6d415d7229f9b7d7f47" args="(const self &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">polybori::PBoRiError::PBoRiError </td> <td>(</td> <td class="paramtype">const <a class="el" href="classpolybori_1_1PBoRiError.html">self</a> & </td> <td class="paramname"> <em>rhs</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> copy constructor <p> <p>References <a class="el" href="pbori__defs_8h_source.html#l00226">PBORI_TRACE_FUNC</a>.</p> </div> </div><p> <a class="anchor" name="b43e2f69698e1c41856a1ab7d18eec29"></a><!-- doxytag: member="polybori::PBoRiError::~PBoRiError" ref="b43e2f69698e1c41856a1ab7d18eec29" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">polybori::PBoRiError::~PBoRiError </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> destructor <p> <p>References <a class="el" href="pbori__defs_8h_source.html#l00226">PBORI_TRACE_FUNC</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="9403bd5831ffef32d90440695fb63236"></a><!-- doxytag: member="polybori::PBoRiError::code" ref="9403bd5831ffef32d90440695fb63236" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">PBoRiError::errornum_type</a> polybori::PBoRiError::code </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> get error code <p> <p>References <a class="el" href="PBoRiError_8h_source.html#l00080">error</a>, and <a class="el" href="pbori__defs_8h_source.html#l00226">PBORI_TRACE_FUNC</a>.</p> </div> </div><p> <a class="anchor" name="8f8c4d0b81f31d54bcc6523375e90bd5"></a><!-- doxytag: member="polybori::PBoRiError::text" ref="8f8c4d0b81f31d54bcc6523375e90bd5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classpolybori_1_1PBoRiError.html#603483e031f76b4859afe89555eeb6c4">PBoRiError::errortext_type</a> polybori::PBoRiError::text </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> get error text <p> <p>References <a class="el" href="PBoRiError_8h_source.html#l00080">error</a>, and <a class="el" href="pbori__defs_8h_source.html#l00226">PBORI_TRACE_FUNC</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="8196410694524ab5624d3dc480f7c722"></a><!-- doxytag: member="polybori::PBoRiError::error" ref="8196410694524ab5624d3dc480f7c722" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classpolybori_1_1PBoRiError.html#95dfedddd52dc15b61f99b197ea614a5">errornum_type</a> <a class="el" href="classpolybori_1_1PBoRiError.html#8196410694524ab5624d3dc480f7c722">polybori::PBoRiError::error</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Referenced by <a class="el" href="PBoRiError_8cc_source.html#l00060">code()</a>, and <a class="el" href="PBoRiError_8cc_source.html#l00067">text()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="PBoRiError_8h_source.html">PBoRiError.h</a><li><a class="el" href="PBoRiError_8cc.html">PBoRiError.cc</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 9 14:31:04 2009 for PolyBoRi by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>