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

Revision 657, 38.3 KB checked in by mattausch, 18 years ago (diff)

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