<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>rlog: rlog::Error Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.0 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li id="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</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="nav"> <b>rlog</b>::<a class="el" href="classrlog_1_1Error.html">Error</a></div> <h1>rlog::Error Class Reference</h1><!-- doxytag: class="rlog::Error" --><a class="el" href="classrlog_1_1Error.html">Error</a> Used as exception thrown from <a class="el" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert()</a> on failure. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="Error_8h-source.html">rlog/Error.h</a>></code> <p> <a href="classrlog_1_1Error-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 Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adf3770381b6aaf6079a38aba25185d9"></a><!-- doxytag: member="rlog::Error::Error" ref="adf3770381b6aaf6079a38aba25185d9" args="(const char *component, const char *file, const char *function, int line, const char *msg)" --> </td><td class="memItemRight" valign="bottom"><b>Error</b> (const char *component, const char *file, const char *function, int line, const char *msg)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="943b9796ad26606f2d4c47e31de72933"></a><!-- doxytag: member="rlog::Error::Error" ref="943b9796ad26606f2d4c47e31de72933" args="(const char *component, const char *file, const char *function, int line, const std::string &msg)" --> </td><td class="memItemRight" valign="bottom"><b>Error</b> (const char *component, const char *file, const char *function, int line, const std::string &msg)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a8fe127272d93097eef0414eab86b52"></a><!-- doxytag: member="rlog::Error::Error" ref="7a8fe127272d93097eef0414eab86b52" args="(const Error &src)" --> </td><td class="memItemRight" valign="bottom"><b>Error</b> (const <a class="el" href="classrlog_1_1Error.html">Error</a> &src)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0b954404d880b8d0c3fd257c18fc978"></a><!-- doxytag: member="rlog::Error::operator=" ref="c0b954404d880b8d0c3fd257c18fc978" args="(const Error &src)" --> <a class="el" href="classrlog_1_1Error.html">Error</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classrlog_1_1Error.html">Error</a> &src)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrlog_1_1Error.html#73d7ca74ba17bea01a9cb817d44a14f7">log</a> (<a class="el" href="classrlog_1_1RLogChannel.html">RLogChannel</a> *channel) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrlog_1_1Error.html#4e02dd30366b894c791192c9a7cde5ca">component</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71279f0acdd9cfd754930b71f8d7a2cb"></a><!-- doxytag: member="rlog::Error::file" ref="71279f0acdd9cfd754930b71f8d7a2cb" args="() const" --> const char * </td><td class="memItemRight" valign="bottom"><b>file</b> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26797c3ebe4927efc92e3ff8b8f98723"></a><!-- doxytag: member="rlog::Error::function" ref="26797c3ebe4927efc92e3ff8b8f98723" args="() const" --> const char * </td><td class="memItemRight" valign="bottom"><b>function</b> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="342affca3351aa73df25d52a4cea901f"></a><!-- doxytag: member="rlog::Error::line" ref="342affca3351aa73df25d52a4cea901f" args="() const" --> int </td><td class="memItemRight" valign="bottom"><b>line</b> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5a9cda275f6630409e01b38f7894d6d"></a><!-- doxytag: member="rlog::Error::message" ref="d5a9cda275f6630409e01b38f7894d6d" args="() const" --> const char * </td><td class="memItemRight" valign="bottom"><b>message</b> () const</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classrlog_1_1Error.html">Error</a> Used as exception thrown from <a class="el" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert()</a> on failure. <p> <a class="el" href="classrlog_1_1Error.html">Error</a> is derived from std::runtime_error exception and is thrown from <a class="el" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert()</a> to indicate the reason and location of the failure.<p> <div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> testFunc() { <span class="keywordtype">bool</span> testAssert = <span class="keyword">true</span>; <a class="code" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert</a>( testAssert == <span class="keyword">false</span> ); <span class="comment">// fails..</span> } <span class="keywordtype">void</span> A() { <span class="keywordflow">try</span> { testFunc(); } <span class="keywordflow">catch</span>( Error &err ) { <a class="code" href="group__RLogMacros.html#ge8be8a2d2e9da76cb70e2f29e0801f73">rDebug</a>(<span class="stringliteral">"caught assert failure from %s line %i ( %s )"</span>, err.file(), err.line(), err.function() ); } } </pre></div><p> <dl class="author" compact><dt><b>Author:</b></dt><dd>Valient Gough </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert()</a> </dd></dl> <p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="73d7ca74ba17bea01a9cb817d44a14f7"></a><!-- doxytag: member="rlog::Error::log" ref="73d7ca74ba17bea01a9cb817d44a14f7" args="(RLogChannel *channel) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Error::log </td> <td>(</td> <td class="paramtype"><a class="el" href="classrlog_1_1RLogChannel.html">RLogChannel</a> * </td> <td class="paramname"> <em>channel</em> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Log the error to the given channel </div> </div><p> <a class="anchor" name="4e02dd30366b894c791192c9a7cde5ca"></a><!-- doxytag: member="rlog::Error::component" ref="4e02dd30366b894c791192c9a7cde5ca" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char * Error::component </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> return component string. If this was due to an <a class="el" href="rlog_8h.html#964127b894c48e2d41a5e6bdbcc3455b">rAssert()</a> then this will be the definition of RLOG_COMPONENT at the point of the rAssert. </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="Error_8h-source.html">Error.h</a><li>Error.cpp</ul> <hr size="1"><address style="align: right;"><small>Generated on Mon Nov 20 22:57:44 2006 for rlog by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address> </body> </html>