Public Types | Public Member Functions | Protected Attributes | List of all members
Ogre::RenderingAPIException Class Reference

#include <OgreException.h>

Inheritance diagram for Ogre::RenderingAPIException:
Inheritance graph
[legend]

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

 RenderingAPIException (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 229 of file OgreException.h.

Member Enumeration Documentation

◆ 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

◆ RenderingAPIException()

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

Definition at line 232 of file OgreException.h.

Member Function Documentation

◆ getDescription()

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

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.

◆ getFile()

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

Gets source file name.

Definition at line 154 of file OgreException.h.

◆ getFullDescription()

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.

◆ getLine()

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

Gets line number.

Definition at line 158 of file OgreException.h.

◆ getNumber()

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

Gets the error code.

◆ getSource()

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

Gets the source function.

Definition at line 150 of file OgreException.h.

◆ what()

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

Override std::exception::what.

Definition at line 167 of file OgreException.h.

Member Data Documentation

◆ description

String Ogre::Exception::description
protectedinherited

Definition at line 90 of file OgreException.h.

◆ file

String Ogre::Exception::file
protectedinherited

Definition at line 92 of file OgreException.h.

◆ fullDesc

String Ogre::Exception::fullDesc
mutableprotectedinherited

Definition at line 93 of file OgreException.h.

◆ line

long Ogre::Exception::line
protectedinherited

Definition at line 87 of file OgreException.h.

◆ number

int Ogre::Exception::number
protectedinherited

Definition at line 88 of file OgreException.h.

◆ source

String Ogre::Exception::source
protectedinherited

Definition at line 91 of file OgreException.h.

◆ typeName

String Ogre::Exception::typeName
protectedinherited

Definition at line 89 of file OgreException.h.


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15