Ogre::Exception Class Reference

When thrown, provides information about an error that has occurred inside the engine. More...

#include <OgreException.h>

Inheritance diagram for Ogre::Exception:

Collaboration diagram for Ogre::Exception:

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

Detailed Description

When thrown, provides information about an error that has occurred inside the engine.

Remarks

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& e) {} block.

The user application should never create any instances of this object unless it wishes to unify its error handling using the same object.

Definition at line 84 of file OgreException.h.

Member Enumeration Documentation

enum Ogre::Exception::ExceptionCodes

Static definitions of error codes.

Enumerator
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

Definition at line 100 of file OgreException.h.

Constructor & Destructor Documentation

Ogre::Exception::Exception	(	int	number,
		const String &	description,
		const String &	source
	)

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 ( )

inline

Needed for compatibility with std::exception.

Definition at line 126 of file OgreException.h.

Member Function Documentation

virtual const String& Ogre::Exception::getDescription ( void  ) const

inlinevirtual

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 const String& Ogre::Exception::getFile ( ) const

inlinevirtual

Gets source file name.

Definition at line 154 of file OgreException.h.

virtual const String& Ogre::Exception::getFullDescription ( void  ) const

virtual

Returns a string with the full description of this error.

Remarks

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.

virtual long Ogre::Exception::getLine ( ) const

inlinevirtual

Gets line number.

Definition at line 158 of file OgreException.h.

virtual int Ogre::Exception::getNumber ( void  ) const throw ( )

virtual

Gets the error code.

virtual const String& Ogre::Exception::getSource ( ) const

inlinevirtual

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 ( )

inline

Override std::exception::what.

Definition at line 167 of file OgreException.h.

Member Data Documentation

String Ogre::Exception::description

protected

Definition at line 90 of file OgreException.h.

String Ogre::Exception::file

protected

Definition at line 92 of file OgreException.h.

String Ogre::Exception::fullDesc

mutableprotected

Definition at line 93 of file OgreException.h.

long Ogre::Exception::line

protected

Definition at line 87 of file OgreException.h.

int Ogre::Exception::number

protected

Definition at line 88 of file OgreException.h.

String Ogre::Exception::source

protected

Definition at line 91 of file OgreException.h.

String Ogre::Exception::typeName

protected

Definition at line 89 of file OgreException.h.

---

The documentation for this class was generated from the following file:

• OgreException.h