source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1Exception.html @ 692

Revision 692, 38.6 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
RevLine 
[692]1<html>
2<head>
3<title>Ogre::Exception class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::Exception Class Reference</h1>When thrown, provides information about an error that has occurred inside the engine. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreException_8h-source.html">OgreException.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Exception-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12">ExceptionCodes</a> { <br>
19&nbsp;&nbsp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw0">UNIMPLEMENTED_FEATURE</a>,
20<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw1">ERR_CANNOT_WRITE_TO_FILE</a>,
21<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw2">ERR_NO_RENDERSYSTEM_SELECTED</a>,
22<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw3">ERR_DIALOG_OPEN_ERROR</a>,
23<br>
24&nbsp;&nbsp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw4">ERR_INVALIDPARAMS</a>,
25<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw5">ERR_RENDERINGAPI_ERROR</a>,
26<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw6">ERR_DUPLICATE_ITEM</a>,
27<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw7">ERR_ITEM_NOT_FOUND</a>,
28<br>
29&nbsp;&nbsp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw8">ERR_FILE_NOT_FOUND</a>,
30<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw9">ERR_INTERNAL_ERROR</a>,
31<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw10">ERR_RT_ASSERTION_FAILED</a>,
32<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12Ogre_1_1Exceptionw11">ERR_NOT_IMPLEMENTED</a>
33<br>
34 }</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static definitions of error codes.  <a href="#Ogre_1_1Exceptionw12">More...</a><br><br></td></tr>
37<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona0">Exception</a> (int <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp1">number</a>, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp2">description</a>, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp3">source</a>)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#Ogre_1_1Exceptiona0"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona1">Exception</a> (int <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp1">number</a>, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp2">description</a>, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp3">source</a>, char *<a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp4">file</a>, long <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp0">line</a>)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Advanced constructor.  <a href="#Ogre_1_1Exceptiona1"></a><br><br></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona2">Exception</a> (const <a class="el" href="classOgre_1_1Exception.html">Exception</a> &amp;rhs)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#Ogre_1_1Exceptiona2"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona3">operator=</a> (const <a class="el" href="classOgre_1_1Exception.html">Exception</a> &amp;rhs)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator.  <a href="#Ogre_1_1Exceptiona3"></a><br><br></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona4">getFullDescription</a> (void) const </td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a string with the full description of this error.  <a href="#Ogre_1_1Exceptiona4"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona5">getNumber</a> (void) const   throw ()</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the error code.  <a href="#Ogre_1_1Exceptiona5"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona6">getSource</a> () const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the source function.  <a href="#Ogre_1_1Exceptiona6"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona7">getFile</a> () const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets source file name.  <a href="#Ogre_1_1Exceptiona7"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona8">getLine</a> () const </td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets line number.  <a href="#Ogre_1_1Exceptiona8"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiona9">getDescription</a> (void) const </td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a string with only the 'description' field of this exception.  <a href="#Ogre_1_1Exceptiona9"></a><br><br></td></tr>
68<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Exception.html">Exception</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptione0">getLastException</a> (void)  throw ()</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a pointer to the last exception created.  <a href="#Ogre_1_1Exceptione0"></a><br><br></td></tr>
72<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptione1">_pushFunction</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;strFuncName)  throw ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pushes a function on the stack.  <a href="#Ogre_1_1Exceptione1"></a><br><br></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptione2">_popFunction</a> ()  throw ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pops a function from the stack.  <a href="#Ogre_1_1Exceptione2"></a><br><br></td></tr>
78<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp0">line</a></td></tr>
80
81<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp1">number</a></td></tr>
82
83<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp2">description</a></td></tr>
84
85<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp3">source</a></td></tr>
86
87<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp4">file</a></td></tr>
88
89<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp5">stackDepth</a></td></tr>
90
91<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
92<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Exception.html">Exception</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont0">last</a></td></tr>
93
94<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont1">msFunctionStack</a> [OGRE_CALL_STACK_DEPTH]</td></tr>
95
96<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont2">msStackDepth</a></td></tr>
97
98</table>
99<hr><a name="_details"></a><h2>Detailed Description</h2>
100When thrown, provides information about an error that has occurred inside the engine.
101<p>
102<dl compact><dt><b>Remarks:</b></dt><dd>OGRE never uses return values to indicate errors. Instead, if an error occurs, an exception is thrown, and this is the object that encapsulates the detail of the problem. The application using OGRE should always ensure that the exceptions are caught, so all OGRE engine functions should occur within a try{} catch(Ogre::Exception&amp; e) {} block. </dd></dl>
103<dl compact><dt><b></b></dt><dd>The user application should never create any instances of this object unless it wishes to unify its error handling using the same object. </dd></dl>
104
105<p>
106
107<p>
108Definition at line <a class="el" href="OgreException_8h-source.html#l00105">105</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.<hr><h2>Member Enumeration Documentation</h2>
109<a class="anchor" name="Ogre_1_1Exceptionw12" doxytag="Ogre::Exception::ExceptionCodes" ></a><p>
110<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
111  <tr>
112    <td class="mdRow">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionw12">Ogre::Exception::ExceptionCodes</a>
116      </table>
117    </td>
118  </tr>
119</table>
120<table cellspacing=5 cellpadding=0 border=0>
121  <tr>
122    <td>
123      &nbsp;
124    </td>
125    <td>
126
127<p>
128Static definitions of error codes.
129<p>
130<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Add many more exception codes, since we want the user to be able to catch most of them. </dd></dl>
131<dl compact><dt><b>Enumeration values: </b></dt><dd>
132<table border=0 cellspacing=2 cellpadding=0>
133<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw0" doxytag="UNIMPLEMENTED_FEATURE" ></a>UNIMPLEMENTED_FEATURE</em>&nbsp;</td><td>
134</td></tr>
135<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw1" doxytag="ERR_CANNOT_WRITE_TO_FILE" ></a>ERR_CANNOT_WRITE_TO_FILE</em>&nbsp;</td><td>
136</td></tr>
137<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw2" doxytag="ERR_NO_RENDERSYSTEM_SELECTED" ></a>ERR_NO_RENDERSYSTEM_SELECTED</em>&nbsp;</td><td>
138</td></tr>
139<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw3" doxytag="ERR_DIALOG_OPEN_ERROR" ></a>ERR_DIALOG_OPEN_ERROR</em>&nbsp;</td><td>
140</td></tr>
141<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw4" doxytag="ERR_INVALIDPARAMS" ></a>ERR_INVALIDPARAMS</em>&nbsp;</td><td>
142</td></tr>
143<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw5" doxytag="ERR_RENDERINGAPI_ERROR" ></a>ERR_RENDERINGAPI_ERROR</em>&nbsp;</td><td>
144</td></tr>
145<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw6" doxytag="ERR_DUPLICATE_ITEM" ></a>ERR_DUPLICATE_ITEM</em>&nbsp;</td><td>
146</td></tr>
147<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw7" doxytag="ERR_ITEM_NOT_FOUND" ></a>ERR_ITEM_NOT_FOUND</em>&nbsp;</td><td>
148</td></tr>
149<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw8" doxytag="ERR_FILE_NOT_FOUND" ></a>ERR_FILE_NOT_FOUND</em>&nbsp;</td><td>
150</td></tr>
151<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw9" doxytag="ERR_INTERNAL_ERROR" ></a>ERR_INTERNAL_ERROR</em>&nbsp;</td><td>
152</td></tr>
153<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw10" doxytag="ERR_RT_ASSERTION_FAILED" ></a>ERR_RT_ASSERTION_FAILED</em>&nbsp;</td><td>
154</td></tr>
155<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Exceptionw12Ogre_1_1Exceptionw11" doxytag="ERR_NOT_IMPLEMENTED" ></a>ERR_NOT_IMPLEMENTED</em>&nbsp;</td><td>
156</td></tr>
157</table>
158</dl>
159
160<p>
161Definition at line <a class="el" href="OgreException_8h-source.html#l00124">124</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
162  </tr>
163</table>
164<hr><h2>Constructor &amp; Destructor Documentation</h2>
165<a class="anchor" name="Ogre_1_1Exceptiona0" doxytag="Ogre::Exception::Exception" ></a><p>
166<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
167  <tr>
168    <td class="mdRow">
169      <table cellpadding="0" cellspacing="0" border="0">
170        <tr>
171          <td class="md" nowrap valign="top"> Ogre::Exception::Exception </td>
172          <td class="md" valign="top">(&nbsp;</td>
173          <td class="md" nowrap valign="top">int&nbsp;</td>
174          <td class="mdname" nowrap> <em>number</em>, </td>
175        </tr>
176        <tr>
177          <td class="md" nowrap align="right"></td>
178          <td></td>
179          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
180          <td class="mdname" nowrap> <em>description</em>, </td>
181        </tr>
182        <tr>
183          <td class="md" nowrap align="right"></td>
184          <td></td>
185          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
186          <td class="mdname" nowrap> <em>source</em></td>
187        </tr>
188        <tr>
189          <td></td>
190          <td class="md">)&nbsp;</td>
191          <td class="md" colspan="2"></td>
192        </tr>
193
194      </table>
195    </td>
196  </tr>
197</table>
198<table cellspacing=5 cellpadding=0 border=0>
199  <tr>
200    <td>
201      &nbsp;
202    </td>
203    <td>
204
205<p>
206Default constructor.
207<p>
208    </td>
209  </tr>
210</table>
211<a class="anchor" name="Ogre_1_1Exceptiona1" doxytag="Ogre::Exception::Exception" ></a><p>
212<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
213  <tr>
214    <td class="mdRow">
215      <table cellpadding="0" cellspacing="0" border="0">
216        <tr>
217          <td class="md" nowrap valign="top"> Ogre::Exception::Exception </td>
218          <td class="md" valign="top">(&nbsp;</td>
219          <td class="md" nowrap valign="top">int&nbsp;</td>
220          <td class="mdname" nowrap> <em>number</em>, </td>
221        </tr>
222        <tr>
223          <td class="md" nowrap align="right"></td>
224          <td></td>
225          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
226          <td class="mdname" nowrap> <em>description</em>, </td>
227        </tr>
228        <tr>
229          <td class="md" nowrap align="right"></td>
230          <td></td>
231          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
232          <td class="mdname" nowrap> <em>source</em>, </td>
233        </tr>
234        <tr>
235          <td class="md" nowrap align="right"></td>
236          <td></td>
237          <td class="md" nowrap>char *&nbsp;</td>
238          <td class="mdname" nowrap> <em>file</em>, </td>
239        </tr>
240        <tr>
241          <td class="md" nowrap align="right"></td>
242          <td></td>
243          <td class="md" nowrap>long&nbsp;</td>
244          <td class="mdname" nowrap> <em>line</em></td>
245        </tr>
246        <tr>
247          <td></td>
248          <td class="md">)&nbsp;</td>
249          <td class="md" colspan="2"></td>
250        </tr>
251
252      </table>
253    </td>
254  </tr>
255</table>
256<table cellspacing=5 cellpadding=0 border=0>
257  <tr>
258    <td>
259      &nbsp;
260    </td>
261    <td>
262
263<p>
264Advanced constructor.
265<p>
266    </td>
267  </tr>
268</table>
269<a class="anchor" name="Ogre_1_1Exceptiona2" doxytag="Ogre::Exception::Exception" ></a><p>
270<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
271  <tr>
272    <td class="mdRow">
273      <table cellpadding="0" cellspacing="0" border="0">
274        <tr>
275          <td class="md" nowrap valign="top"> Ogre::Exception::Exception </td>
276          <td class="md" valign="top">(&nbsp;</td>
277          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Exception.html">Exception</a> &amp;&nbsp;</td>
278          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
279          <td class="md" valign="top">&nbsp;)&nbsp;</td>
280          <td class="md" nowrap></td>
281        </tr>
282
283      </table>
284    </td>
285  </tr>
286</table>
287<table cellspacing=5 cellpadding=0 border=0>
288  <tr>
289    <td>
290      &nbsp;
291    </td>
292    <td>
293
294<p>
295Copy constructor.
296<p>
297    </td>
298  </tr>
299</table>
300<hr><h2>Member Function Documentation</h2>
301<a class="anchor" name="Ogre_1_1Exceptione2" doxytag="Ogre::Exception::_popFunction" ></a><p>
302<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
303  <tr>
304    <td class="mdRow">
305      <table cellpadding="0" cellspacing="0" border="0">
306        <tr>
307          <td class="md" nowrap valign="top"> void Ogre::Exception::_popFunction </td>
308          <td class="md" valign="top">(&nbsp;</td>
309          <td class="mdname1" valign="top" nowrap>          </td>
310          <td class="md" valign="top">&nbsp;)&nbsp;</td>
311          <td class="md" nowrap>  throw ()<code> [static]</code></td>
312        </tr>
313
314      </table>
315    </td>
316  </tr>
317</table>
318<table cellspacing=5 cellpadding=0 border=0>
319  <tr>
320    <td>
321      &nbsp;
322    </td>
323    <td>
324
325<p>
326Pops a function from the stack.
327<p>
328    </td>
329  </tr>
330</table>
331<a class="anchor" name="Ogre_1_1Exceptione1" doxytag="Ogre::Exception::_pushFunction" ></a><p>
332<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
333  <tr>
334    <td class="mdRow">
335      <table cellpadding="0" cellspacing="0" border="0">
336        <tr>
337          <td class="md" nowrap valign="top"> void Ogre::Exception::_pushFunction </td>
338          <td class="md" valign="top">(&nbsp;</td>
339          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
340          <td class="mdname1" valign="top" nowrap> <em>strFuncName</em>          </td>
341          <td class="md" valign="top">&nbsp;)&nbsp;</td>
342          <td class="md" nowrap>  throw ()<code> [static]</code></td>
343        </tr>
344
345      </table>
346    </td>
347  </tr>
348</table>
349<table cellspacing=5 cellpadding=0 border=0>
350  <tr>
351    <td>
352      &nbsp;
353    </td>
354    <td>
355
356<p>
357Pushes a function on the stack.
358<p>
359    </td>
360  </tr>
361</table>
362<a class="anchor" name="Ogre_1_1Exceptiona9" doxytag="Ogre::Exception::getDescription" ></a><p>
363<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
364  <tr>
365    <td class="mdRow">
366      <table cellpadding="0" cellspacing="0" border="0">
367        <tr>
368          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Exception::getDescription </td>
369          <td class="md" valign="top">(&nbsp;</td>
370          <td class="md" nowrap valign="top">void&nbsp;</td>
371          <td class="mdname1" valign="top" nowrap>          </td>
372          <td class="md" valign="top">&nbsp;)&nbsp;</td>
373          <td class="md" nowrap> const</td>
374        </tr>
375
376      </table>
377    </td>
378  </tr>
379</table>
380<table cellspacing=5 cellpadding=0 border=0>
381  <tr>
382    <td>
383      &nbsp;
384    </td>
385    <td>
386
387<p>
388Returns a string with only the 'description' field of this exception.
389<p>
390Use getFullDescriptionto get a full description of the error including line number, error number and what function threw the exception.
391<p>
392Definition at line <a class="el" href="OgreException_8h-source.html#l00187">187</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.
393<p>
394References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
395  </tr>
396</table>
397<a class="anchor" name="Ogre_1_1Exceptiona7" doxytag="Ogre::Exception::getFile" ></a><p>
398<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
399  <tr>
400    <td class="mdRow">
401      <table cellpadding="0" cellspacing="0" border="0">
402        <tr>
403          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Exception::getFile </td>
404          <td class="md" valign="top">(&nbsp;</td>
405          <td class="mdname1" valign="top" nowrap>          </td>
406          <td class="md" valign="top">&nbsp;)&nbsp;</td>
407          <td class="md" nowrap> const</td>
408        </tr>
409
410      </table>
411    </td>
412  </tr>
413</table>
414<table cellspacing=5 cellpadding=0 border=0>
415  <tr>
416    <td>
417      &nbsp;
418    </td>
419    <td>
420
421<p>
422Gets source file name.
423<p>
424
425<p>
426Definition at line <a class="el" href="OgreException_8h-source.html#l00177">177</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.
427<p>
428References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
429  </tr>
430</table>
431<a class="anchor" name="Ogre_1_1Exceptiona4" doxytag="Ogre::Exception::getFullDescription" ></a><p>
432<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
433  <tr>
434    <td class="mdRow">
435      <table cellpadding="0" cellspacing="0" border="0">
436        <tr>
437          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::Exception::getFullDescription </td>
438          <td class="md" valign="top">(&nbsp;</td>
439          <td class="md" nowrap valign="top">void&nbsp;</td>
440          <td class="mdname1" valign="top" nowrap>          </td>
441          <td class="md" valign="top">&nbsp;)&nbsp;</td>
442          <td class="md" nowrap> const</td>
443        </tr>
444
445      </table>
446    </td>
447  </tr>
448</table>
449<table cellspacing=5 cellpadding=0 border=0>
450  <tr>
451    <td>
452      &nbsp;
453    </td>
454    <td>
455
456<p>
457Returns a string with the full description of this error.
458<p>
459<dl compact><dt><b>Remarks:</b></dt><dd>The description contains the error number, the description supplied by the thrower, what routine threw the exception, and will also supply extra platform-specific information where applicable. For example - in the case of a rendering library error, the description of the error will include both the place in which OGRE found the problem, and a text description from the 3D rendering library, if available. </dd></dl>
460    </td>
461  </tr>
462</table>
463<a class="anchor" name="Ogre_1_1Exceptione0" doxytag="Ogre::Exception::getLastException" ></a><p>
464<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
465  <tr>
466    <td class="mdRow">
467      <table cellpadding="0" cellspacing="0" border="0">
468        <tr>
469          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Exception.html">Exception</a>* Ogre::Exception::getLastException </td>
470          <td class="md" valign="top">(&nbsp;</td>
471          <td class="md" nowrap valign="top">void&nbsp;</td>
472          <td class="mdname1" valign="top" nowrap>          </td>
473          <td class="md" valign="top">&nbsp;)&nbsp;</td>
474          <td class="md" nowrap>  throw ()<code> [static]</code></td>
475        </tr>
476
477      </table>
478    </td>
479  </tr>
480</table>
481<table cellspacing=5 cellpadding=0 border=0>
482  <tr>
483    <td>
484      &nbsp;
485    </td>
486    <td>
487
488<p>
489Retrieves a pointer to the last exception created.
490<p>
491    </td>
492  </tr>
493</table>
494<a class="anchor" name="Ogre_1_1Exceptiona8" doxytag="Ogre::Exception::getLine" ></a><p>
495<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
496  <tr>
497    <td class="mdRow">
498      <table cellpadding="0" cellspacing="0" border="0">
499        <tr>
500          <td class="md" nowrap valign="top"> long Ogre::Exception::getLine </td>
501          <td class="md" valign="top">(&nbsp;</td>
502          <td class="mdname1" valign="top" nowrap>          </td>
503          <td class="md" valign="top">&nbsp;)&nbsp;</td>
504          <td class="md" nowrap> const</td>
505        </tr>
506
507      </table>
508    </td>
509  </tr>
510</table>
511<table cellspacing=5 cellpadding=0 border=0>
512  <tr>
513    <td>
514      &nbsp;
515    </td>
516    <td>
517
518<p>
519Gets line number.
520<p>
521
522<p>
523Definition at line <a class="el" href="OgreException_8h-source.html#l00181">181</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
524  </tr>
525</table>
526<a class="anchor" name="Ogre_1_1Exceptiona5" doxytag="Ogre::Exception::getNumber" ></a><p>
527<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
528  <tr>
529    <td class="mdRow">
530      <table cellpadding="0" cellspacing="0" border="0">
531        <tr>
532          <td class="md" nowrap valign="top"> int Ogre::Exception::getNumber </td>
533          <td class="md" valign="top">(&nbsp;</td>
534          <td class="md" nowrap valign="top">void&nbsp;</td>
535          <td class="mdname1" valign="top" nowrap>          </td>
536          <td class="md" valign="top">&nbsp;)&nbsp;</td>
537          <td class="md" nowrap> const  throw ()</td>
538        </tr>
539
540      </table>
541    </td>
542  </tr>
543</table>
544<table cellspacing=5 cellpadding=0 border=0>
545  <tr>
546    <td>
547      &nbsp;
548    </td>
549    <td>
550
551<p>
552Gets the error code.
553<p>
554    </td>
555  </tr>
556</table>
557<a class="anchor" name="Ogre_1_1Exceptiona6" doxytag="Ogre::Exception::getSource" ></a><p>
558<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
559  <tr>
560    <td class="mdRow">
561      <table cellpadding="0" cellspacing="0" border="0">
562        <tr>
563          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Exception::getSource </td>
564          <td class="md" valign="top">(&nbsp;</td>
565          <td class="md" nowrap valign="top">void&nbsp;</td>
566          <td class="mdname1" valign="top" nowrap>          </td>
567          <td class="md" valign="top">&nbsp;)&nbsp;</td>
568          <td class="md" nowrap> const</td>
569        </tr>
570
571      </table>
572    </td>
573  </tr>
574</table>
575<table cellspacing=5 cellpadding=0 border=0>
576  <tr>
577    <td>
578      &nbsp;
579    </td>
580    <td>
581
582<p>
583Gets the source function.
584<p>
585
586<p>
587Definition at line <a class="el" href="OgreException_8h-source.html#l00173">173</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.
588<p>
589References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
590  </tr>
591</table>
592<a class="anchor" name="Ogre_1_1Exceptiona3" doxytag="Ogre::Exception::operator=" ></a><p>
593<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
594  <tr>
595    <td class="mdRow">
596      <table cellpadding="0" cellspacing="0" border="0">
597        <tr>
598          <td class="md" nowrap valign="top"> void Ogre::Exception::operator= </td>
599          <td class="md" valign="top">(&nbsp;</td>
600          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Exception.html">Exception</a> &amp;&nbsp;</td>
601          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
602          <td class="md" valign="top">&nbsp;)&nbsp;</td>
603          <td class="md" nowrap></td>
604        </tr>
605
606      </table>
607    </td>
608  </tr>
609</table>
610<table cellspacing=5 cellpadding=0 border=0>
611  <tr>
612    <td>
613      &nbsp;
614    </td>
615    <td>
616
617<p>
618Assignment operator.
619<p>
620    </td>
621  </tr>
622</table>
623<hr><h2>Member Data Documentation</h2>
624<a class="anchor" name="Ogre_1_1Exceptionp2" doxytag="Ogre::Exception::description" ></a><p>
625<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
626  <tr>
627    <td class="mdRow">
628      <table cellpadding="0" cellspacing="0" border="0">
629        <tr>
630          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp2">Ogre::Exception::description</a><code> [protected]</code>
631      </table>
632    </td>
633  </tr>
634</table>
635<table cellspacing=5 cellpadding=0 border=0>
636  <tr>
637    <td>
638      &nbsp;
639    </td>
640    <td>
641
642<p>
643
644<p>
645Definition at line <a class="el" href="OgreException_8h-source.html#l00110">110</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
646  </tr>
647</table>
648<a class="anchor" name="Ogre_1_1Exceptionp4" doxytag="Ogre::Exception::file" ></a><p>
649<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
650  <tr>
651    <td class="mdRow">
652      <table cellpadding="0" cellspacing="0" border="0">
653        <tr>
654          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp4">Ogre::Exception::file</a><code> [protected]</code>
655      </table>
656    </td>
657  </tr>
658</table>
659<table cellspacing=5 cellpadding=0 border=0>
660  <tr>
661    <td>
662      &nbsp;
663    </td>
664    <td>
665
666<p>
667
668<p>
669Definition at line <a class="el" href="OgreException_8h-source.html#l00112">112</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
670  </tr>
671</table>
672<a class="anchor" name="Ogre_1_1Exceptiont0" doxytag="Ogre::Exception::last" ></a><p>
673<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
674  <tr>
675    <td class="mdRow">
676      <table cellpadding="0" cellspacing="0" border="0">
677        <tr>
678          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Exception.html">Exception</a>* <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont0">Ogre::Exception::last</a><code> [static, protected]</code>
679      </table>
680    </td>
681  </tr>
682</table>
683<table cellspacing=5 cellpadding=0 border=0>
684  <tr>
685    <td>
686      &nbsp;
687    </td>
688    <td>
689
690<p>
691
692<p>
693Definition at line <a class="el" href="OgreException_8h-source.html#l00114">114</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
694  </tr>
695</table>
696<a class="anchor" name="Ogre_1_1Exceptionp0" doxytag="Ogre::Exception::line" ></a><p>
697<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
698  <tr>
699    <td class="mdRow">
700      <table cellpadding="0" cellspacing="0" border="0">
701        <tr>
702          <td class="md" nowrap valign="top"> long <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp0">Ogre::Exception::line</a><code> [protected]</code>
703      </table>
704    </td>
705  </tr>
706</table>
707<table cellspacing=5 cellpadding=0 border=0>
708  <tr>
709    <td>
710      &nbsp;
711    </td>
712    <td>
713
714<p>
715
716<p>
717Definition at line <a class="el" href="OgreException_8h-source.html#l00108">108</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
718  </tr>
719</table>
720<a class="anchor" name="Ogre_1_1Exceptiont1" doxytag="Ogre::Exception::msFunctionStack" ></a><p>
721<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
722  <tr>
723    <td class="mdRow">
724      <table cellpadding="0" cellspacing="0" border="0">
725        <tr>
726          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont1">Ogre::Exception::msFunctionStack</a>[ OGRE_CALL_STACK_DEPTH ]<code> [static, protected]</code>
727      </table>
728    </td>
729  </tr>
730</table>
731<table cellspacing=5 cellpadding=0 border=0>
732  <tr>
733    <td>
734      &nbsp;
735    </td>
736    <td>
737
738<p>
739
740<p>
741Definition at line <a class="el" href="OgreException_8h-source.html#l00116">116</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
742  </tr>
743</table>
744<a class="anchor" name="Ogre_1_1Exceptiont2" doxytag="Ogre::Exception::msStackDepth" ></a><p>
745<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
746  <tr>
747    <td class="mdRow">
748      <table cellpadding="0" cellspacing="0" border="0">
749        <tr>
750          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a467">ushort</a> <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptiont2">Ogre::Exception::msStackDepth</a><code> [static, protected]</code>
751      </table>
752    </td>
753  </tr>
754</table>
755<table cellspacing=5 cellpadding=0 border=0>
756  <tr>
757    <td>
758      &nbsp;
759    </td>
760    <td>
761
762<p>
763
764<p>
765Definition at line <a class="el" href="OgreException_8h-source.html#l00117">117</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
766  </tr>
767</table>
768<a class="anchor" name="Ogre_1_1Exceptionp1" doxytag="Ogre::Exception::number" ></a><p>
769<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
770  <tr>
771    <td class="mdRow">
772      <table cellpadding="0" cellspacing="0" border="0">
773        <tr>
774          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp1">Ogre::Exception::number</a><code> [protected]</code>
775      </table>
776    </td>
777  </tr>
778</table>
779<table cellspacing=5 cellpadding=0 border=0>
780  <tr>
781    <td>
782      &nbsp;
783    </td>
784    <td>
785
786<p>
787
788<p>
789Definition at line <a class="el" href="OgreException_8h-source.html#l00109">109</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
790  </tr>
791</table>
792<a class="anchor" name="Ogre_1_1Exceptionp3" doxytag="Ogre::Exception::source" ></a><p>
793<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
794  <tr>
795    <td class="mdRow">
796      <table cellpadding="0" cellspacing="0" border="0">
797        <tr>
798          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp3">Ogre::Exception::source</a><code> [protected]</code>
799      </table>
800    </td>
801  </tr>
802</table>
803<table cellspacing=5 cellpadding=0 border=0>
804  <tr>
805    <td>
806      &nbsp;
807    </td>
808    <td>
809
810<p>
811
812<p>
813Definition at line <a class="el" href="OgreException_8h-source.html#l00111">111</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
814  </tr>
815</table>
816<a class="anchor" name="Ogre_1_1Exceptionp5" doxytag="Ogre::Exception::stackDepth" ></a><p>
817<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
818  <tr>
819    <td class="mdRow">
820      <table cellpadding="0" cellspacing="0" border="0">
821        <tr>
822          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a467">ushort</a> <a class="el" href="classOgre_1_1Exception.html#Ogre_1_1Exceptionp5">Ogre::Exception::stackDepth</a><code> [protected]</code>
823      </table>
824    </td>
825  </tr>
826</table>
827<table cellspacing=5 cellpadding=0 border=0>
828  <tr>
829    <td>
830      &nbsp;
831    </td>
832    <td>
833
834<p>
835
836<p>
837Definition at line <a class="el" href="OgreException_8h-source.html#l00113">113</a> of file <a class="el" href="OgreException_8h-source.html">OgreException.h</a>.    </td>
838  </tr>
839</table>
840<hr>The documentation for this class was generated from the following file:<ul>
841<li><a class="el" href="OgreException_8h-source.html">OgreException.h</a></ul>
842<hr>
843<p>
844Copyright &copy; 2000-2005 by The OGRE Team<br />
845<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
846This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
847                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
848                <Work rdf:about="">
849                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
850        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
851                </Work>
852                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
853
854Last modified Sun Mar 12 14:38:50 2006
855</p>
856</body>
857</html>
Note: See TracBrowser for help on using the repository browser.