FountainException Class Reference

A base class for all exceptions thrown by various Fountain components. More...

#include <FountainErrors.h>

Inheritance diagram for FountainException:

FatalFountainException List of all members.

Public Member Functions

 FountainException (const std::string &msg=std::string(), FountainErrorCode code=unknownFailure) throw ()
 Create an exception with the error string msg and FountainErrorCode code.
 FountainException (const char *msg, FountainErrorCode code=unknownFailure) throw ()
 Create an exception with the error string msg and FountainErrorCode code.
virtual ~FountainException () throw ()
 Destructor.
FountainErrorCode getCode () const
 Get the error code.
virtual bool isFatal () const

Private Attributes

FountainErrorCode code_
 The error code for this exception.
std::string what_
 The error string for this exception.

Detailed Description

A base class for all exceptions thrown by various Fountain components.


Constructor & Destructor Documentation

FountainException::FountainException const std::string &  msg = std::string(),
FountainErrorCode  code = unknownFailure
throw ()
 

Create an exception with the error string msg and FountainErrorCode code.

Parameters:
msg The string containing the error message
code The FountainErrorCode describing the failure

FountainException::FountainException const char *  msg,
FountainErrorCode  code = unknownFailure
throw ()
 

Create an exception with the error string msg and FountainErrorCode code.

Parameters:
msg The string containing the error message
code The FountainErrorCode describing the failure


Member Function Documentation

FountainErrorCode FountainException::getCode  )  const [inline]
 

Get the error code.

Returns:
The FountainErrorCode for this exception

virtual bool FountainException::isFatal  )  const [inline, virtual]
 

Returns:
false this exception should not be rethrown when caught

Reimplemented in FatalFountainException.


The documentation for this class was generated from the following files:
Generated on Wed Mar 8 14:43:32 2006 for Fountain by  doxygen 1.4.6