Gaudi::Guards::ExceptionGuard Class Reference

The most simple guard - it execute the certain code withing typical "try {} catch" clause, used in Auditor, Algorithm, AlgTool, etc. More...

#include <GaudiKernel/Guards.h>

Collaboration diagram for Gaudi::Guards::ExceptionGuard:

Public Member Functions
template<class OBJECT, class FUNCTION>
	ExceptionGuard (OBJECT obj, FUNCTION fun, MsgStream &log, IExceptionSvc *svc=0)
	~ExceptionGuard ()
	destructor
const StatusCode &	code () const
	the result of function evaluation
	operator const StatusCode & () const
	cast operator, useful for the implicit conversions

Protected Member Functions
void	handle (const GaudiException &e, MsgStream &s)
	local handler of GaudiException
void	handle (const std::exception &e, MsgStream &s)
	local handler of std::exception
void	handle (MsgStream &s)
	local handler of UNKNOWN exceptions

Private Member Functions
	ExceptionGuard ()=delete
	ExceptionGuard (const ExceptionGuard &)=delete
ExceptionGuard &	operator= (const ExceptionGuard &)=delete

Private Attributes
StatusCode	m_sc = StatusCode::FAILURE
	status code : result of function evaluation

Detailed Description

The most simple guard - it execute the certain code withing typical "try {} catch" clause, used in Auditor, Algorithm, AlgTool, etc.

. classes

The usage is fairly trivial:

// get the stream:
MsgStream& log = ... ;
 
// create the guard object and execute this->initialize()
// within the  standard "try"-clause:
Gaudi::Guards::Guard guard
        ( this                               ,   
          std::mem_fn(&IAuditor::initialize) ,   
          log                                ) ; 
 
// extract the status code"
StatusCode sc = guard.code() ;

The utility could be reused for member-function, regular functions, etc.. It could be easily combined with STL-idioms Essentially it required only the semantical validity of the expression "StatusCode sc = fun(obj)"

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-03-07

Definition at line 104 of file Guards.h.

Constructor & Destructor Documentation

ExceptionGuard() [1/3]

template<class OBJECT, class FUNCTION>

Gaudi::Guards::ExceptionGuard::ExceptionGuard ( OBJECT obj, FUNCTION fun, MsgStream & log, IExceptionSvc * svc = 0 )

inline

< execute the functor

Definition at line 112 of file Guards.h.

                                                                                         {
        try {
          // execute the functor:
          m_sc = fun( obj ); 
          // in the case of error try use Exception Service
          if ( svc && m_sc.isFailure() ) { m_sc = svc->handleErr( *obj, m_sc ); }
        } catch ( const GaudiException& e ) {
          // Use the local handler and then (if possible) the Exception Service
          handle( e, log );
          if ( svc ) { m_sc = svc->handle( *obj, e ); }
        } catch ( const std::exception& e ) {
          // Use the local handler and then (if possible) the Exception Service
          handle( e, log );
          if ( svc ) { m_sc = svc->handle( *obj, e ); }
        } catch ( ... ) {
          // Use the local handler and then (if possible) the Exception Service
          handle( log );
          if ( svc ) { m_sc = svc->handle( *obj ); }
        }

~ExceptionGuard()

Gaudi::Guards::ExceptionGuard::~ExceptionGuard

(

)

destructor

Definition at line 40 of file Guards.cpp.

{ m_sc.ignore(); }

ExceptionGuard() [2/3]

Gaudi::Guards::ExceptionGuard::ExceptionGuard ( )

privatedelete

ExceptionGuard() [3/3]

Gaudi::Guards::ExceptionGuard::ExceptionGuard ( const ExceptionGuard & )

privatedelete

Member Function Documentation

code()

const StatusCode & Gaudi::Guards::ExceptionGuard::code ( ) const

inline

the result of function evaluation

Definition at line 137 of file Guards.h.

handle() [1/3]

void Gaudi::Guards::ExceptionGuard::handle ( const GaudiException & e, MsgStream & s )

protected

local handler of GaudiException

Definition at line 25 of file Guards.cpp.

                                                                                  {
  log << MSG::FATAL << System::typeinfoName( typeid( exc ) ) << "('" << exc.tag() << "') is caught!" << endmsg;
  log << MSG::ERROR << exc << endmsg;
  m_sc = exc.code();
}

handle() [2/3]

void Gaudi::Guards::ExceptionGuard::handle ( const std::exception & e, MsgStream & s )

protected

local handler of std::exception

Definition at line 31 of file Guards.cpp.

                                                                                {
  log << MSG::FATAL << System::typeinfoName( typeid( exc ) ) << " is caught!" << endmsg;
  log << MSG::ERROR << exc.what() << endmsg;
}

handle() [3/3]

void Gaudi::Guards::ExceptionGuard::handle ( MsgStream & s )

protected

local handler of UNKNOWN exceptions

Definition at line 36 of file Guards.cpp.

                                                       {
  log << MSG::FATAL << "UNKNOWN exception is caught!" << endmsg;
}

operator const StatusCode &()

Gaudi::Guards::ExceptionGuard::operator const StatusCode & ( ) const

inline

cast operator, useful for the implicit conversions

Definition at line 139 of file Guards.h.

operator=()

ExceptionGuard & Gaudi::Guards::ExceptionGuard::operator= ( const ExceptionGuard & )

privatedelete

Member Data Documentation

m_sc

StatusCode Gaudi::Guards::ExceptionGuard::m_sc = StatusCode::FAILURE

private

status code : result of function evaluation

Definition at line 157 of file Guards.h.

---

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

• GaudiKernel/include/GaudiKernel/Guards.h
• GaudiKernel/src/Lib/Guards.cpp