Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::Error Class Reference

TSE3 exception base class. More...

#include <Error.h>

Inheritance diagram for TSE3::Error:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Error (ErrorCode reason)
 ~Error () throw ()
ErrorCode reason () const
virtual const char * what () const throw ()

Detailed Description

TSE3 exception base class.

This is the base class of all TSE3 errors.

The Error class provides a reason code for each type of error that can be raised, although subclasses are also used to distinguish the type of the error. Each subclass may have more than one reason code associated with it. The reason codes are provided by the enum type.

The rationale for the reason codes, rather than use of pure subclassing to denote error type, is to allow the application to provide internationalised error messages for the user. It is easier to lookup a string via an integer reason code than convert a class type to some error string. (See ErrorCode and errString() for more information on this.)

Author:
Pete Goodliffe
Version:
3.00


Constructor & Destructor Documentation

TSE3::Error::Error ErrorCode  reason  )  [inline]
 

Creates an Error object with the specified reason code.

Parameters:
reason Reason code for this Error

TSE3::Error::~Error  )  throw () [inline]
 


Member Function Documentation

ErrorCode TSE3::Error::reason  )  const [inline]
 

Returns the ErrorCode for this Error object.

Use errString to get a string representation of this error.

virtual const char* TSE3::Error::what  )  const throw () [virtual]
 

See also:
TSE3::errString


The documentation for this class was generated from the following file:
Generated on Wed May 25 14:46:07 2005 for TSE3 by doxygen 1.3.2