Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::BasicException Class Reference

The base exception class in the Framework. More...

#include <vcf/FoundationKit/BasicException.h>

Inheritance diagram for VCF::BasicException:

COMException NoImplementerFoundException NoToolKitFoundException VCF::ApplicationException VCF::BadComponentStateException VCF::BadImageBitsException VCF::BadModelStateException VCF::BasicFileError VCF::CantCreateObjectException VCF::ClassNotFound VCF::DataTypeNotSupportedException VCF::ImageLoaderException VCF::InvalidImage VCF::InvalidImplementer VCF::InvalidMessageDialogException VCF::InvalidPeer VCF::InvalidPointerException VCF::InvalidStateException VCF::NetworkException VCF::NoFreeMemException VCF::NoGraphicsToolkitFoundException VCF::NoPeerFoundException VCF::NoSuchElementException VCF::NotImplementedException VCF::OutOfBoundsException VCF::PixelException VCF::PropertyChangeException VCF::RuntimeException VCF::StringsMessageLoader::Exception VCF::ThreadException VCF::TypeCastException VCF::URLAuthenticationException VCF::URLDataException VCF::URLException VCF::XmlException List of all members.

Public Member Functions

 BasicException (const VCF::String &message)
 Basic constructor All Exceptions take a text message identifying (in human readable terms ) what went wrong.
 BasicException (const VCF::String &message, const int lineNumber)
virtual ~BasicException () throw ()
VCF::String getMessage () const
 returns the message text associated with the exception
virtual const char * what () const throw ()
 overrides the std::exception's what() method to return the same as getMessage() does, making this exception (and all it's derivations) suitable for use in try/catch blocks where the catch traps std::exception&.
void setMessage (const VCF::String &message)
 set the error text to be associated with the exception so it is possible to add informations and rethrow the same exception

Detailed Description

The base exception class in the Framework.

All exceptions should try and describe what went wrong as clearly as possible. For convenience a basic set of error strings are defined in ErrorStrings.h.

Version:
1.0
Author:
Jim Crafton


Constructor & Destructor Documentation

VCF::BasicException::BasicException const VCF::String message  ) 
 

Basic constructor All Exceptions take a text message identifying (in human readable terms ) what went wrong.

VCF::BasicException::BasicException const VCF::String message,
const int  lineNumber
 

virtual VCF::BasicException::~BasicException  )  throw () [inline, virtual]
 


Member Function Documentation

VCF::String VCF::BasicException::getMessage  )  const
 

returns the message text associated with the exception

Returns:
String - the error text

void VCF::BasicException::setMessage const VCF::String message  ) 
 

set the error text to be associated with the exception so it is possible to add informations and rethrow the same exception

virtual const char* VCF::BasicException::what  )  const throw () [inline, virtual]
 

overrides the std::exception's what() method to return the same as getMessage() does, making this exception (and all it's derivations) suitable for use in try/catch blocks where the catch traps std::exception&.


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information