GaudiException Class Reference

Define general base for Gaudi exception. More...

#include <GaudiKernel/GaudiException.h>

Inheritance diagram for GaudiException:

Collaboration diagram for GaudiException:

Public Member Functions
	GaudiException (std::string Message, std::string Tag, StatusCode Code)
	Constructor (1) More...
	GaudiException (std::string Message, std::string Tag, StatusCode Code, const GaudiException &Exception)
	Constructor (2) More...
	GaudiException (std::string Message, std::string Tag, StatusCode Code, const std::exception &Exception)
	Constructor (3) More...
	GaudiException (const GaudiException &Exception)
	Copy constructor (deep copying!) More...
virtual	~GaudiException () throw ()
	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 StatusCode &	code () const
	StatusCode for Exception. More...
virtual const StatusCode &	setCode (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 MsgStream &	printOut (MsgStream &os) const
	Output the exception to the Gaudi MsgStream. More...
virtual GaudiException *	clone () const
	clone operation More...
const char *	what () const override throw ()
	method from std::exception More...
Public Member Functions inherited from std::exception
T	what (T...args)
T	~exception (T...args)
T	operator= (T...args)
T	exception (T...args)

Protected Attributes
std::string	m_message
std::string	m_tag
	error message More...
StatusCode	m_code
	exception tag More...
std::unique_ptr< GaudiException >	m_previous
	status code for exception More...

Static Protected Attributes
static bool	s_proc
	"previous" element in the linked list More...

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

Detailed Description

Define general base for Gaudi exception.

Author

Vanya Belyaev

Sebastien Ponce

Definition at line 23 of file GaudiException.h.

Constructor & Destructor Documentation

GaudiException::GaudiException ( std::string  Message, std::string  Tag, StatusCode  Code  )

inline

Constructor (1)

Parameters

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

Definition at line 41 of file GaudiException.h.

    : m_message    ( std::move(Message)   )
    , m_tag        ( std::move(Tag)       )
    , m_code       ( std::move(Code)      )
    { s_proc = true; }

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

inline

Constructor (2)

Parameters

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

Definition at line 55 of file GaudiException.h.

    : m_message    ( std::move(Message)            )
    , m_tag        ( std::move(Tag)                )
    , m_code       ( std::move(Code)               )
    , m_previous   ( Exception.clone()  )
    {}

GaudiException::GaudiException ( std::string  Message, std::string  Tag, StatusCode  Code, const std::exception &  Exception  )

inline

Constructor (3)

Parameters

Message	error message
Tag	"name tag", or exeption type
Code	status code
Exception	"previous" exception (used to improve the error message)

Definition at line 71 of file GaudiException.h.

    : m_message    ( std::move(Message)   )
    , m_tag        ( std::move(Tag)       )
    , m_code       ( std::move(Code)      )
    {
      s_proc = true;
      m_message += ": " + System::typeinfoName(typeid(Exception)) + ", " +
                   Exception.what();
    }

GaudiException::GaudiException ( const GaudiException &  Exception )

inline

Copy constructor (deep copying!)

Definition at line 85 of file GaudiException.h.

     : std::exception(Exception)
     , m_message{     Exception.message() } 
     , m_tag    {     Exception.tag    () }
     , m_code   {     Exception.code   () }
     , m_previous{  Exception.previous() ? Exception.previous()->clone() : nullptr }
  {
    s_proc     = true;
  }

virtual GaudiException::~GaudiException ( ) throw ( )

inlinevirtual

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

Definition at line 96 of file GaudiException.h.

                                    {
    m_code.setChecked();
    s_proc = false;
  }

Member Function Documentation

virtual GaudiException* GaudiException::clone ( ) const

inlinevirtual

clone operation

Reimplemented in UpdateManagerException.

Definition at line 160 of file GaudiException.h.

{ return new GaudiException(*this); }

virtual const StatusCode& GaudiException::code ( ) const

inlinevirtual

StatusCode for Exception.

Definition at line 127 of file GaudiException.h.

{ return m_code; }

virtual const std::string& GaudiException::message ( ) const

inlinevirtual

error message to be printed

Definition at line 111 of file GaudiException.h.

{ return m_message; }

GaudiException& GaudiException::operator= ( const GaudiException &  Exception )

inline

assignment operator

Definition at line 102 of file GaudiException.h.

                                                               {
    m_message  =   Exception.message() ;
    m_tag      =   Exception.tag    () ;
    m_code     =   Exception.code   () ;
    m_previous.reset( Exception.previous() ? Exception.previous()->clone() : nullptr );
    return *this;
  }

virtual GaudiException* GaudiException::previous ( ) const

inlinevirtual

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

Definition at line 135 of file GaudiException.h.

{ return m_previous.get() ; }

virtual std::ostream& GaudiException::printOut ( std::ostream &  os = std::cerr ) const

inlinevirtual

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

Definition at line 138 of file GaudiException.h.

                                                                   {
    os << tag() << " \t " << message() ;
    switch( code() ) {
      case StatusCode::SUCCESS : os << "\t StatusCode=SUCCESS"    ;  break ;
      case StatusCode::FAILURE : os << "\t StatusCode=FAILURE"    ;  break ;
      default                  : os << "\t StatusCode=" << code() ;  break ;
    }
    return ( 0 != previous() ) ? previous()->printOut( os << std::endl ) : os ;
  }

virtual MsgStream& GaudiException::printOut ( MsgStream &  os ) const

inlinevirtual

Output the exception to the Gaudi MsgStream.

Definition at line 149 of file GaudiException.h.

                                                      {
    os << tag() << "\t" << message() ;
    switch( code() ) {
        case StatusCode::SUCCESS : os << "\t StatusCode=SUCCESS"    ;  break ;
        case StatusCode::FAILURE : os << "\t StatusCode=FAILURE"    ;  break ;
        default                  : os << "\t StatusCode=" << code().getCode() ;  break ;
    }
    return ( 0 != previous() ) ? previous()->printOut( os << endmsg ) : os ;
  }

virtual const StatusCode& GaudiException::setCode ( const StatusCode &  newStatus )

inlinevirtual

update the status code for the exception

Definition at line 130 of file GaudiException.h.

                                                                           {
    m_code = newStatus; return code() ;
  }

virtual const std::string& GaudiException::setMessage ( const std::string &  newMessage )

inlinevirtual

update the error message to be printed

Definition at line 114 of file GaudiException.h.

                                                                        {
    m_message = newMessage; return message() ;
  }

virtual const std::string& GaudiException::setTag ( const std::string &  newTag )

inlinevirtual

update name tag

Definition at line 122 of file GaudiException.h.

                                                                        {
    m_tag = newTag ; return tag() ;
  }

virtual const std::string& GaudiException::tag ( ) const

inlinevirtual

name tag for the exception, or exception type

Definition at line 119 of file GaudiException.h.

{ return m_tag; }

const char* GaudiException::what ( ) const throw ( )

inlineoverride

method from std::exception

Definition at line 163 of file GaudiException.h.

{ return message().c_str() ; }

Friends And Related Function Documentation

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

friend

overloaded printout to std::ostream

Definition at line 173 of file GaudiException.h.

                                                                       {
  return ge.printOut( os );
}

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

friend

Definition at line 176 of file GaudiException.h.

{ return (0 == pge) ?
    ( os << " GaudiException* points to NULL!" ) : ( os << *pge ); }

MsgStream& operator<< ( MsgStream &  os, const GaudiException &  ge  )

friend

overloaded printout to MsgStream

Definition at line 181 of file GaudiException.h.

                                                                           {
  return ge.printOut( os );
}

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

friend

overloaded printout to MsgStream

Definition at line 185 of file GaudiException.h.

                                                                           {
  return (0 == pge) ?
    ( os << " GaudiException* points to NULL!" ) : ( os << *pge );
}

friend class StatusCode

friend

Definition at line 33 of file GaudiException.h.

Member Data Documentation

StatusCode GaudiException::m_code

mutableprotected

exception tag

Definition at line 167 of file GaudiException.h.

std::string GaudiException::m_message

mutableprotected

Definition at line 165 of file GaudiException.h.

std::unique_ptr<GaudiException> GaudiException::m_previous

mutableprotected

status code for exception

Definition at line 168 of file GaudiException.h.

std::string GaudiException::m_tag

mutableprotected

error message

Definition at line 166 of file GaudiException.h.

bool GaudiException::s_proc

staticprotected

"previous" element in the linked list

Definition at line 169 of file GaudiException.h.

---

The documentation for this class was generated from the following files:

• GaudiKernel/GaudiKernel/GaudiException.h
• GaudiKernel/src/Lib/GaudiException.cpp