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

Phx::RangeException Class Reference

A RangeException is thrown whenever a value is outside of a legal range for a parameter. More...

#include <PhxExceptions.h>

Inheritance diagram for Phx::RangeException:

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 RangeException is thrown whenever a value is outside of a legal range for a parameter.

This is frequently thrown as a result of attempting to construct an object in an invalid state. e.g., one might have an object that represents an integer with limited range, and whose constructor throws a RangeException if the client attempts to construct it with an integral value that is outside of the legal bounds.


Member Function Documentation

virtual const char* Phx::RangeException::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::Exception.


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