Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Phx::MemoryException Class Reference

A memory exception can be thrown when it is found that a memory allocation has failed. More...

#include <PhxExceptions.h>

Inheritance diagram for Phx::MemoryException:

Phx::ResourceException Phx::Exception List of all members.

Public Member Functions

virtual const char * what () const throw ()
 Overloads the std::exception what() method to return a brief message.

Detailed Description

A memory exception can be thrown when it is found that a memory allocation has failed.

This is not necessarily a memory exhaustion error. It may be that a specific quantity of memory was reserved for a task (e.g., texture caching) and that memory has been filled. In response to such an error, a caller may be able to catch this exception, free some memory within the system that generated the error, and then retry its request.


Member Function Documentation

virtual const char* Phx::MemoryException::what  )  const throw () [inline, virtual]
 

Overloads the std::exception what() method to return a brief message.

In general, the message should be very short, usually just specifying the type of error. Any information about the cause of the error itself that is not useful for programatic purposes should be logged rather than returned in the exception.

Reimplemented from Phx::ResourceException.


The documentation for this class was generated from the following file:
Generated on Wed Dec 21 22:05:39 2005 for Phoenix OSFS by  doxygen 1.4.2