Crazy Eddie's GUI System  0.8.5
CEGUI::MemoryException Class Reference

Exception class used when a memory handling error is detected. More...

+ Inheritance diagram for CEGUI::MemoryException:
+ Collaboration diagram for CEGUI::MemoryException:

Public Member Functions

 MemoryException (const String &message, const String &file="unknown", int line=0, const String &function="unknown")
 Constructor that is responsible for logging the memory exception by calling the base class. More...
 
- Public Member Functions inherited from CEGUI::Exception
virtual ~Exception (void) throw ()
 Virtual destructor.
 
const StringgetMessage (void) const
 Return a reference to the String object describing the reason for the exception being thrown. More...
 
const StringgetName () const
 Return a reference to the String object containing the exception name (i.e. class type). More...
 
const StringgetFileName (void) const
 Return a reference to the String object containing the name of the file where the exception occurred. More...
 
int getLine (void) const
 Return the line number where the exception occurred. More...
 
const StringgetFunctionName (void) const
 Return a reference to the String object containing the name of the function where the exception occurred. More...
 
const char * what () const throw ()
 

Additional Inherited Members

- Static Public Member Functions inherited from CEGUI::Exception
static void setStdErrEnabled (bool enabled)
 Sets whether every exception construction should output to stderr. More...
 
static bool isStdErrEnabled ()
 Checks whether newly constructed exceptions will output to stderr. More...
 
- Protected Member Functions inherited from CEGUI::Exception
 Exception (const String &message="", const String &name="CEGUI::Exception", const String &filename="", int line=0, const String &function="")
 Protected constructor that prevents instantiations (users should employ derived exception classes instead) and that is responsible for logging the exception. More...
 
- Protected Attributes inherited from CEGUI::Exception
String d_message
 Holds the reason for the exception being thrown.
 
String d_name
 Holds the class name of the exception (e.g. CEGUI::ObjectInUseException)
 
String d_filename
 Holds the name of the file where the exception occurred.
 
int d_line
 Holds the line number where the exception occurred.
 
String d_function
 Holds the name of the function where the exception occurred.
 
String d_what
 Holds the default error message.
 
- Static Protected Attributes inherited from CEGUI::Exception
static bool d_stdErrEnabled
 if this is true, newly constructed exceptions will output to stderr
 

Detailed Description

Exception class used when a memory handling error is detected.

Constructor & Destructor Documentation

CEGUI::MemoryException::MemoryException ( const String message,
const String file = "unknown",
int  line = 0,
const String function = "unknown" 
)
inline

Constructor that is responsible for logging the memory exception by calling the base class.

Parameters
messageString object describing the reason for the memory exception being thrown.
filenameString object containing the name of the file where the memory exception occurred.
lineInteger representing the line number where the memory exception occurred.
functionString object containing the name of the function where the exception occurred.
Remarks
The memory exception name is automatically passed to the base class as "CEGUI::MemoryException".