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

GaudiException Class Reference

Define general base for Gaudi exception. More...

#include <GaudiKernel/GaudiException.h>

Inheritance diagram for GaudiException:

std::exception List of all members.

Public Methods

 GaudiException ( const std::string& Message, const std::string& Tag, const StatusCode & Code )
 Constructor (1). More...

 GaudiException ( const std::string& Message , const std::string& Tag , const StatusCode & Code , const GaudiException& Exception )
 Constructor (1). More...

 GaudiException ( const GaudiException& Exception )
 Copy constructor (deep copying!). More...

virtual ~GaudiException ()
 destructor (perform the deletion of "previous" field!). More...

GaudiException& operator= ( const GaudiException& Exception )
 assignment operator. More...

virtual const std::string& message () const
 error message to be printed. More...

virtual const std::string& setMessage ( const std::string& newMessage )
 update the error message to be printed. More...

virtual const std::string& tag () const
 name tag for the exception, or exception type. More...

virtual const std::string& setTag ( const std::string& newTag )
 update name tag. More...

virtual const StatusCodecode () const
 StatusCode for Exception. More...

virtual const StatusCodesetCode ( const StatusCode& newStatus )
 update the status code for the exception. More...

virtual GaudiException* previous () const
 get the previous exception ( "previous" element in the linked list). More...

virtual std::ostream& printOut ( std::ostream& os = std::cerr ) const
 methods for overloaded printout to std::ostream& and MsgStream&. More...

virtual MsgStreamprintOut ( MsgStream& os ) const
 Output the exception to the Gaudi MsgStream. More...

virtual GaudiException* clone () const
 clone operation. More...

virtual const char* what () const
 method from std::exception. More...


Protected Attributes

std::string m_message
std::string m_tag
 error message. More...

StatusCode m_code
 exception tag. More...

GaudiException* m_previous
 status code for exception. More...


Friends

std::ostream& operator<< ( std::ostream& os , const GaudiException& ge )
 overloaded printout to std::ostream. More...

std::ostream& operator<< ( std::ostream& os , const GaudiException* pge )
MsgStreamoperator<< ( MsgStream& os , const GaudiException& ge )
 overloaded printout to MsgStream. More...

MsgStreamoperator<< ( MsgStream& os , const GaudiException* pge )
 overloaded printout to MsgStream. More...


Detailed Description

Define general base for Gaudi exception.

Author(s):
Vanya Belyaev

Definition at line 21 of file GaudiException.h.


Constructor & Destructor Documentation

GaudiException::GaudiException ( const std::string & Message,
const std::string & Tag,
const StatusCode & Code ) [inline]
 

Constructor (1).

Parameters:
Message   error message
Tag   "name tag", or exeption type
Code   status code

Definition at line 34 of file GaudiException.h.

Referenced by clone().

GaudiException::GaudiException ( const std::string & Message,
const std::string & Tag,
const StatusCode & Code,
const GaudiException & Exception ) [inline]
 

Constructor (1).

Parameters:
Message   error message
Tag   "name tag", or exeption type
Code   status code
Exception   "previous" exception

Definition at line 49 of file GaudiException.h.

GaudiException::GaudiException ( const GaudiException & Exception ) [inline]
 

Copy constructor (deep copying!).

Definition at line 60 of file GaudiException.h.

GaudiException::~GaudiException ( ) [inline, virtual]
 

destructor (perform the deletion of "previous" field!).

Definition at line 68 of file GaudiException.h.


Member Function Documentation

GaudiException * GaudiException::clone ( ) const [inline, virtual]
 

clone operation.

Definition at line 125 of file GaudiException.h.

Referenced by GaudiException(), and operator=().

const StatusCode & GaudiException::code ( ) const [inline, virtual]
 

StatusCode for Exception.

Definition at line 94 of file GaudiException.h.

Referenced by GaudiException(), operator=(), printOut(), and setCode().

const std::string & GaudiException::message ( ) const [inline, virtual]
 

error message to be printed.

Definition at line 82 of file GaudiException.h.

Referenced by GaudiException(), operator=(), printOut(), setMessage(), and what().

GaudiException & GaudiException::operator= ( const GaudiException & Exception ) [inline]
 

assignment operator.

Definition at line 71 of file GaudiException.h.

GaudiException * GaudiException::previous ( ) const [inline, virtual]
 

get the previous exception ( "previous" element in the linked list).

Definition at line 100 of file GaudiException.h.

Referenced by GaudiException(), operator=(), and printOut().

MsgStream & GaudiException::printOut ( MsgStream & os ) const [inline, virtual]
 

Output the exception to the Gaudi MsgStream.

Definition at line 114 of file GaudiException.h.

std::ostream & GaudiException::printOut ( std::ostream & os = std::cerr ) const [inline, virtual]
 

methods for overloaded printout to std::ostream& and MsgStream&.

Definition at line 103 of file GaudiException.h.

Referenced by operator<<(), and printOut().

const StatusCode & GaudiException::setCode ( const StatusCode & newStatus ) [inline, virtual]
 

update the status code for the exception.

Definition at line 97 of file GaudiException.h.

const std::string & GaudiException::setMessage ( const std::string & newMessage ) [inline, virtual]
 

update the error message to be printed.

Definition at line 85 of file GaudiException.h.

const std::string & GaudiException::setTag ( const std::string & newTag ) [inline, virtual]
 

update name tag.

Definition at line 91 of file GaudiException.h.

const std::string & GaudiException::tag ( ) const [inline, virtual]
 

name tag for the exception, or exception type.

Definition at line 88 of file GaudiException.h.

Referenced by GaudiException(), operator=(), printOut(), and setTag().

const char * GaudiException::what ( ) const [inline, virtual]
 

method from std::exception.

Definition at line 128 of file GaudiException.h.


Friends And Related Function Documentation

MsgStream & operator<< ( MsgStream & os,
const GaudiException * pge ) [friend]
 

overloaded printout to MsgStream.

Definition at line 146 of file GaudiException.h.

MsgStream & operator<< ( MsgStream & os,
const GaudiException & ge ) [friend]
 

overloaded printout to MsgStream.

Definition at line 142 of file GaudiException.h.

std::ostream & operator<< ( std::ostream & os,
const GaudiException * pge ) [friend]
 

Definition at line 138 of file GaudiException.h.

std::ostream & operator<< ( std::ostream & os,
const GaudiException & ge ) [friend]
 

overloaded printout to std::ostream.

Definition at line 137 of file GaudiException.h.


Member Data Documentation

StatusCode GaudiException::m_code [mutable, protected]
 

exception tag.

Definition at line 132 of file GaudiException.h.

std::string GaudiException::m_message [mutable, protected]
 

Definition at line 130 of file GaudiException.h.

GaudiException * GaudiException::m_previous [mutable, protected]
 

status code for exception.

Definition at line 133 of file GaudiException.h.

std::string GaudiException::m_tag [mutable, protected]
 

error message.

Definition at line 131 of file GaudiException.h.


The documentation for this class was generated from the following file:
Generated at Wed Nov 21 12:22:10 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000