When thrown, provides information about an error that has occurred inside the engine. More...
#include <OgreException.h>
Public Types | |
enum | ExceptionCodes { ERR_CANNOT_WRITE_TO_FILE, ERR_INVALID_STATE, ERR_INVALIDPARAMS, ERR_RENDERINGAPI_ERROR, ERR_DUPLICATE_ITEM, ERR_ITEM_NOT_FOUND, ERR_FILE_NOT_FOUND, ERR_INTERNAL_ERROR, ERR_RT_ASSERTION_FAILED, ERR_NOT_IMPLEMENTED } |
Static definitions of error codes. More... | |
Public Member Functions | |
Exception (int number, const String &description, const String &source) | |
Default constructor. More... | |
Exception (int number, const String &description, const String &source, const char *type, const char *file, long line) | |
Advanced constructor. More... | |
Exception (const Exception &rhs) | |
Copy constructor. More... | |
~Exception () throw () | |
Needed for compatibility with std::exception. More... | |
virtual const String & | getDescription (void) const |
Returns a string with only the 'description' field of this exception. More... | |
virtual const String & | getFile () const |
Gets source file name. More... | |
virtual const String & | getFullDescription (void) const |
Returns a string with the full description of this error. More... | |
virtual long | getLine () const |
Gets line number. More... | |
virtual int | getNumber (void) const throw () |
Gets the error code. More... | |
virtual const String & | getSource () const |
Gets the source function. More... | |
void | operator= (const Exception &rhs) |
Assignment operator. More... | |
const char * | what () const throw () |
Override std::exception::what. More... | |
Protected Attributes | |
String | description |
String | file |
String | fullDesc |
long | line |
int | number |
String | source |
String | typeName |
When thrown, provides information about an error that has occurred inside the engine.
Definition at line 84 of file OgreException.h.
Default constructor.
Ogre::Exception::Exception | ( | int | number, |
const String & | description, | ||
const String & | source, | ||
const char * | type, | ||
const char * | file, | ||
long | line | ||
) |
Advanced constructor.
Ogre::Exception::Exception | ( | const Exception & | rhs | ) |
Copy constructor.
Ogre::Exception::~Exception | ( | ) | ||
throw | ( | |||
) |
Needed for compatibility with std::exception.
Definition at line 126 of file OgreException.h.
|
virtual |
Returns a string with only the 'description' field of this exception.
Use getFullDescriptionto get a full description of the error including line number, error number and what function threw the exception.
Definition at line 164 of file OgreException.h.
|
virtual |
Gets source file name.
Definition at line 154 of file OgreException.h.
|
virtual |
Returns a string with the full description of this error.
|
virtual |
Gets line number.
Definition at line 158 of file OgreException.h.
|
virtual |
Gets the error code.
|
virtual |
Gets the source function.
Definition at line 150 of file OgreException.h.
void Ogre::Exception::operator= | ( | const Exception & | rhs | ) |
Assignment operator.
const char* Ogre::Exception::what | ( | ) | const | |
throw | ( | |||
) |
Override std::exception::what.
Definition at line 167 of file OgreException.h.
|
protected |
Definition at line 90 of file OgreException.h.
|
protected |
Definition at line 92 of file OgreException.h.
|
mutableprotected |
Definition at line 93 of file OgreException.h.
|
protected |
Definition at line 87 of file OgreException.h.
|
protected |
Definition at line 88 of file OgreException.h.
|
protected |
Definition at line 91 of file OgreException.h.
|
protected |
Definition at line 89 of file OgreException.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.