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 >
2003-04-27 18:54:58 +00:00
< a class = "qindex" href = "index.html" > Main Page< / a > < a class = "qindex" href = "namespaces.html" > Namespace List< / a > < a class = "qindex" href = "annotated.html" > Compound List< / a > < a class = "qindex" href = "files.html" > File List< / a > < a class = "qindex" href = "namespacemembers.html" > Namespace Members< / a > < a class = "qindex" href = "functions.html" > Compound Members< / a > < a class = "qindex" href = "globals.html" > File Members< / a > < / center >
2003-01-18 22:54:50 +00:00
< hr > < h1 > ZE::ZError Class Reference< / h1 > < code > #include < < a class = "el" href = "ZE__ZError_8h-source.html" > ZE_ZError.h< / a > > < / code >
< p >
< a href = "classZE_1_1ZError-members.html" > List of all members.< / a > < hr > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
2003-04-27 18:54:58 +00:00
< a class = "el" href = "classZE_1_1ZError.html" > ZError< / a > class for storing and printing information on errors. Inherited from ZObject 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 >
2003-01-18 22:54:50 +00:00
< p >
< table border = 0 cellpadding = 0 cellspacing = 0 >
< tr > < td > < / td > < / tr >
< tr > < td colspan = 2 > < br > < h2 > Public Methods< / h2 > < / td > < / tr >
2003-04-27 18:54:58 +00:00
< tr > < td nowrap align = right valign = top > < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#a0" > ZError< / a > (< a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > code=ZERR_NONE, string desc="", string file="", int line=0)< / td > < / tr >
2003-01-18 22:54:50 +00:00
< tr > < td > < / 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 >
2003-04-27 18:54:58 +00:00
< tr > < td nowrap align = right valign = top > virtual < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#a1" > ~ZError< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Virtual Destructor.< / em > < a href = "#a1" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > void < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#a2" > Create< / a > (< a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > code, string desc="", string file="", int line=0)< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Set members of error object.< / em > < a href = "#a2" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > < a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#a3" > Code< / a > () const< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Get ZErrorCode of error.< / em > < a href = "#a3" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > string < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#a4" > LogString< / a > () const< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Get formatted string for log file.< / em > < a href = "#a4" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
2003-01-28 21:33:02 +00:00
< tr > < td colspan = 2 > < br > < h2 > Static Public Methods< / h2 > < / td > < / tr >
< tr > < td nowrap align = right valign = top > void < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#d0" > CreateStringTable< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Construct string table for error strings.< / em > < a href = "#d0" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > void < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#d1" > DestroyStringTable< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Destroy string table of error strings.< / em > < a href = "#d1" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
2003-01-18 22:54:50 +00:00
< 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 >
2003-04-27 18:54:58 +00:00
< a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#n0" > rCode< / a > < / td > < / tr >
2003-01-18 22:54:50 +00:00
< tr > < td > < / 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 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#n1" > rDescription< / a > < / td > < / tr >
< tr > < td > < / 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 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#n2" > rFilename< / a > < / td > < / tr >
< tr > < td > < / 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 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#n3" > rLine< / a > < / td > < / tr >
< tr > < td > < / 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 >
2003-01-28 21:33:02 +00:00
< tr > < td nowrap align = right valign = top > < a name = "q0" doxytag = "ZE::ZError::sErrorDesc" > < / a >
string * < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZError.html#q0" > sErrorDesc< / a > = NULL< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Static Array of Error Identifiers.< / em > < / font > < br > < br > < / td > < / tr >
2003-01-18 22:54:50 +00:00
< / table >
< hr > < h2 > Constructor & 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" > ( < / td >
2003-04-27 18:54:58 +00:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > < / td >
2003-01-18 22:54:50 +00:00
< td class = "mdname" nowrap > < em > code< / em > = ZERR_NONE, < / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td class = "md" nowrap > string < / td >
< td class = "mdname" nowrap > < em > desc< / em > = "", < / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td class = "md" nowrap > string < / td >
< td class = "mdname" nowrap > < em > file< / em > = "", < / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td class = "md" nowrap > int < / td >
< td class = "mdname" nowrap > < em > line< / em > = 0< / td >
< / tr >
< tr >
< td > < / td >
< td class = "md" > ) < / td >
< td class = "md" colspan = "2" > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / 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 > < / td > < td > ZErrorCode to set object to, defaults to ZERR_NONE. < / td > < / tr >
< tr > < td valign = top > < em > desc< / em > < / td > < td > Description to use for object, defaults to nothing. < / td > < / tr >
< tr > < td valign = top > < em > file< / em > < / td > < td > Optional argument specifying the file the error occured in. < / td > < / tr >
< tr > < td valign = top > < em > line< / em > < / td > < td > Optional argument specifying the line the error occured on. < / td > < / tr >
< / table >
< / dl >
< / td >
< / tr >
< / table >
2003-04-27 18:54:58 +00:00
< a name = "a1" 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" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < code > [virtual]< / code > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Virtual destructor making future inheritance safe. < / td >
< / tr >
< / table >
2003-01-18 22:54:50 +00:00
< hr > < h2 > Member Function Documentation< / h2 >
2003-01-28 21:33:02 +00:00
< a name = "d0" doxytag = "ZE::ZError::CreateStringTable" > < / 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::CreateStringTable < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < code > [static]< / code > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Constructs a string table for errors, enabling < a class = "el" href = "classZE_1_1ZEngine.html" > ZEngine< / a > to properly delete the table on exit. < / td >
< / tr >
< / table >
< a name = "d1" doxytag = "ZE::ZError::DestroyStringTable" > < / 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::DestroyStringTable < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < code > [static]< / code > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Properly delete the string table, freeing all memory used by the strings. < / td >
< / tr >
< / table >
2003-04-27 18:54:58 +00:00
< a name = "a2" doxytag = "ZE::ZError::Create" > < / a > < p >
2003-01-18 22:54:50 +00:00
< 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" > ( < / td >
2003-04-27 18:54:58 +00:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > < / td >
2003-01-18 22:54:50 +00:00
< td class = "mdname" nowrap > < em > code< / em > , < / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td class = "md" nowrap > string < / td >
< td class = "mdname" nowrap > < em > desc< / em > = "", < / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td class = "md" nowrap > string < / td >
< td class = "mdname" nowrap > < em > file< / em > = "", < / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td class = "md" nowrap > int < / td >
< td class = "mdname" nowrap > < em > line< / em > = 0< / td >
< / tr >
< tr >
< td > < / td >
< td class = "md" > ) < / td >
< td class = "md" colspan = "2" > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / 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 > < / td > < td > ZErrorCode to set object to. < / td > < / tr >
< tr > < td valign = top > < em > desc< / em > < / td > < td > Description to use for object, defaults to nothing. < / td > < / tr >
< tr > < td valign = top > < em > file< / em > < / td > < td > Optional argument specifying the file the error occured in. < / td > < / tr >
< tr > < td valign = top > < em > line< / em > < / td > < td > Optional argument specifying the line the error occured on. < / td > < / tr >
< / table >
< / dl >
< / td >
< / tr >
< / table >
2003-04-27 18:54:58 +00:00
< a name = "a3" doxytag = "ZE::ZError::Code" > < / a > < p >
2003-01-18 22:54:50 +00:00
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2003-04-27 18:54:58 +00:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "namespaceZE.html#a20" > ZErrorCode< / a > ZE::ZError::Code < / td >
2003-01-18 22:54:50 +00:00
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > const< / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / 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 >
2003-04-27 18:54:58 +00:00
< a name = "a4" doxytag = "ZE::ZError::LogString" > < / a > < p >
2003-01-18 22:54:50 +00:00
< 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" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > const< / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / 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 > 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 >
2003-04-27 18:54:58 +00:00
< hr > < address style = "align: right;" > < small > Generated on Sun Apr 27 14:53:40 2003 for ZEngine by
2003-01-18 22:54:50 +00:00
< 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 >
