jpt-archive/zengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
dac9e24e1e
zengine/doc/html/classZE_1_1ZError.html

259 lines
12 KiB
HTML
Raw Normal View History

0.8.2 docs
2003-01-18 22:54:50 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ZE::ZError class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc2 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE::ZError Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZError_8h-source.html">ZE_ZError.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZError-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classZE_1_1ZError.html">ZError</a> class for storing and printing information on errors. Inherited from <a class="el" href="classZE_1_1ZObject.html">ZObject</a> and tied closely to <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. <dl compact><dt><b>Since:</b></dt><dd>0.8.2 </dd></dl>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a0">ZError</a> (<a class="el" href="namespaceZE.html#a16">ZErrorCode</a> code=ZERR_NONE, string desc="", string file="", int line=0)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor for <a class="el" href="classZE_1_1ZError.html">ZError</a>.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a1">Create</a> (<a class="el" href="namespaceZE.html#a16">ZErrorCode</a> code, string desc="", string file="", int line=0)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set members of error object.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceZE.html#a16">ZErrorCode</a>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a2">Code</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get ZErrorCode of error.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#a3">LogString</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get formatted string for log file.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="n0" doxytag="ZE::ZError::rCode"></a>
<a class="el" href="namespaceZE.html#a16">ZErrorCode</a>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n0">rCode</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Error ID.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZError::rDescription"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n1">rDescription</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Error Description.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZError::rFilename"></a>
string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n2">rFilename</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>File which error occured in.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZError::rLine"></a>
unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#n3">rLine</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Line which error occured on.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZError.html#q0">sErrorDesc</a> [ZERR_LAST]</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Static Array of Error Identifiers.</em> <a href="#q0"></a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ZE::ZError::ZError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ZE::ZError::ZError </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceZE.html#a16">ZErrorCode</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>code</em> = ZERR_NONE, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>desc</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>file</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>line</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Make new <a class="el" href="classZE_1_1ZError.html">ZError</a> object, by default set rCode to ZERR_NONE with no description. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>code</em>&nbsp;</td><td>ZErrorCode to set object to, defaults to ZERR_NONE. </td></tr>
<tr><td valign=top><em>desc</em>&nbsp;</td><td>Description to use for object, defaults to nothing. </td></tr>
<tr><td valign=top><em>file</em>&nbsp;</td><td>Optional argument specifying the file the error occured in. </td></tr>
<tr><td valign=top><em>line</em>&nbsp;</td><td>Optional argument specifying the line the error occured on. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a1" doxytag="ZE::ZError::Create"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ZE::ZError::Create </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceZE.html#a16">ZErrorCode</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>code</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>desc</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>file</em> = "", </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>line</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set new values in <a class="el" href="classZE_1_1ZError.html">ZError</a> object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>code</em>&nbsp;</td><td>ZErrorCode to set object to. </td></tr>
<tr><td valign=top><em>desc</em>&nbsp;</td><td>Description to use for object, defaults to nothing. </td></tr>
<tr><td valign=top><em>file</em>&nbsp;</td><td>Optional argument specifying the file the error occured in. </td></tr>
<tr><td valign=top><em>line</em>&nbsp;</td><td>Optional argument specifying the line the error occured on. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="ZE::ZError::Code"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceZE.html#a16">ZErrorCode</a> ZE::ZError::Code </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Access ZErrorCode of the <a class="el" href="classZE_1_1ZError.html">ZError</a> object. <dl compact><dt><b>Returns:</b></dt><dd>The error ZErrorCode. </dd></dl>
</td>
</tr>
</table>
<a name="a3" doxytag="ZE::ZError::LogString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string ZE::ZError::LogString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the string to be written to the logfile. Called by <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> in LogError. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="q0" doxytag="ZE::ZError::sErrorDesc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string ZE::ZError::sErrorDesc<code> [static, protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Initial value:</b><div class="fragment"><pre>
{
<span class="stringliteral">"No Error. [%s]"</span>,
<span class="stringliteral">"SDL Error. [%s]"</span>,
<span class="stringliteral">"Error Initializing SDL: %s"</span>, <span class="stringliteral">"Error Initializing SDL_mixer: %s"</span>, <span class="stringliteral">"Error Initializing SDL_ttf: %s"</span>,
<span class="stringliteral">"Error Creating Display: %s"</span>,
<span class="stringliteral">"Failed to load Image: %s"</span>, <span class="stringliteral">"Failed to load Sound: %s"</span>, <span class="stringliteral">"Failed to load Music: %s"</span>, <span class="stringliteral">"Failed to load Font: %s"</span>,
<span class="stringliteral">"Called ZImage::%s with no Image loaded."</span>, <span class="stringliteral">"Called ZSound::%s with no Sound loaded."</span>,
<span class="stringliteral">"Called ZMusic::%s with no Music loaded."</span>, <span class="stringliteral">"Called ZFont::%s with no Font loaded."</span>
}
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="ZE__ZError_8h-source.html">ZE_ZError.h</a><li>/src/<a class="el" href="ZE__ZError_8cpp.html">ZE_ZError.cpp</a></ul>
<hr><address style="align: right;"><small>Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3-rc2 </small></address>
</body>
</html>
Reference in New Issue Copy Permalink