OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::InternalErrorException Class Reference

#include <OgreException.h>

+ Inheritance diagram for Ogre::InternalErrorException:
+ Collaboration diagram for Ogre::InternalErrorException:

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

 InternalErrorException (int inNumber, const String &inDescription, const String &inSource, const char *inFile, long inLine)
 
virtual const StringgetDescription (void) const
 Returns a string with only the 'description' field of this exception. More...
 
virtual const StringgetFile () const
 Gets source file name. More...
 
virtual const StringgetFullDescription (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 StringgetSource () const
 Gets the source function. 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

Definition at line 224 of file OgreException.h.

Member Enumeration Documentation

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 101 of file OgreException.h.

Constructor & Destructor Documentation

Ogre::InternalErrorException::InternalErrorException ( int  inNumber,
const String inDescription,
const String inSource,
const char *  inFile,
long  inLine 
)
inline

Definition at line 227 of file OgreException.h.

Member Function Documentation

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

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 165 of file OgreException.h.

virtual const String& Ogre::Exception::getFile ( ) const
inlinevirtualinherited

Gets source file name.

Definition at line 155 of file OgreException.h.

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

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
inlinevirtualinherited

Gets line number.

Definition at line 159 of file OgreException.h.

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

Gets the error code.

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

Gets the source function.

Definition at line 151 of file OgreException.h.

const char* Ogre::Exception::what ( ) const
throw (
)
inlineinherited

Override std::exception::what.

Definition at line 168 of file OgreException.h.

Member Data Documentation

String Ogre::Exception::description
protectedinherited

Definition at line 91 of file OgreException.h.

String Ogre::Exception::file
protectedinherited

Definition at line 93 of file OgreException.h.

String Ogre::Exception::fullDesc
mutableprotectedinherited

Definition at line 94 of file OgreException.h.

long Ogre::Exception::line
protectedinherited

Definition at line 88 of file OgreException.h.

int Ogre::Exception::number
protectedinherited

Definition at line 89 of file OgreException.h.

String Ogre::Exception::source
protectedinherited

Definition at line 92 of file OgreException.h.

String Ogre::Exception::typeName
protectedinherited

Definition at line 90 of file OgreException.h.


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