Loading [MathJax]/extensions/tex2jax.js
The Gaudi Framework  v31r0 (aeb156f0)
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 More...
 
const StatusCodecode () const
 the result of function evaluation More...
 
 operator const StatusCode & () const
 cast operator, useful for the implicit conversions More...
 

Protected Member Functions

void handle (const GaudiException &e, MsgStream &s)
 local handler of GaudiException More...
 
void handle (const std::exception &e, MsgStream &s)
 local handler of std::exception More...
 
void handle (MsgStream &s)
 local handler of UNKNOWN exceptions More...
 

Private Member Functions

 ExceptionGuard ()=delete
 
 ExceptionGuard (const ExceptionGuard &)=delete
 
ExceptionGuardoperator= (const ExceptionGuard &)=delete
 

Private Attributes

StatusCode m_sc = StatusCode::FAILURE
 status code : result of function evaluation More...
 

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 105 of file Guards.h.

Constructor & Destructor Documentation

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 113 of file Guards.h.

113  {
114  try {
115  // execute the functor:
116  m_sc = fun( obj );
117  // in the case of error try use Exception Service
118  if ( svc && m_sc.isFailure() ) { m_sc = svc->handleErr( *obj, m_sc ); }
119  } catch ( const GaudiException& e ) {
120  // Use the local handler and then (if possible) the Exception Service
121  handle( e, log );
122  if ( svc ) { m_sc = svc->handle( *obj, e ); }
123  } catch ( const std::exception& e ) {
124  // Use the local handler and then (if possible) the Exception Service
125  handle( e, log );
126  if ( svc ) { m_sc = svc->handle( *obj, e ); }
127  } catch ( ... ) {
128  // Use the local handler and then (if possible) the Exception Service
129  handle( log );
130  if ( svc ) { m_sc = svc->handle( *obj ); }
131  }
132  }
void handle(const GaudiException &e, MsgStream &s)
local handler of GaudiException
Definition: Guards.cpp:24
Define general base for Gaudi exception.
bool isFailure() const
Definition: StatusCode.h:130
StatusCode m_sc
status code : result of function evaluation
Definition: Guards.h:158
virtual StatusCode handle(const INamedInterface &o, const GaudiException &e) const =0
Handle caught GaudiExceptions.
STL class.
double fun(const std::vector< double > &x)
Definition: PFuncTest.cpp:26
virtual StatusCode handleErr(const INamedInterface &o, const StatusCode &s) const =0
Handle errors.
Gaudi::Guards::ExceptionGuard::~ExceptionGuard ( )

destructor

Definition at line 51 of file Guards.cpp.

51 { m_sc.ignore(); }
StatusCode m_sc
status code : result of function evaluation
Definition: Guards.h:158
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
Gaudi::Guards::ExceptionGuard::ExceptionGuard ( )
privatedelete
Gaudi::Guards::ExceptionGuard::ExceptionGuard ( const ExceptionGuard )
privatedelete

Member Function Documentation

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

the result of function evaluation

Definition at line 138 of file Guards.h.

138 { return m_sc; }
StatusCode m_sc
status code : result of function evaluation
Definition: Guards.h:158
void Gaudi::Guards::ExceptionGuard::handle ( const GaudiException e,
MsgStream s 
)
protected

local handler of GaudiException

Definition at line 24 of file Guards.cpp.

24  {
25  // the general printout
26  log << MSG::FATAL << System::typeinfoName( typeid( exc ) ) << "('" << exc.tag() << "') is caught!" << endmsg;
27  // print the detailes about the exception:
28  log << MSG::ERROR << exc << endmsg;
29  // get the status code form the exception:
30  m_sc = exc.code();
31 }
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:309
StatusCode m_sc
status code : result of function evaluation
Definition: Guards.h:158
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
void Gaudi::Guards::ExceptionGuard::handle ( const std::exception e,
MsgStream s 
)
protected

local handler of std::exception

Definition at line 35 of file Guards.cpp.

35  {
36  // the general printout
37  log << MSG::FATAL << System::typeinfoName( typeid( exc ) ) << " is caught!" << endmsg;
38  // print the detailes abotu the exception:
39  log << MSG::ERROR << exc.what() << endmsg;
40 }
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:309
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
void Gaudi::Guards::ExceptionGuard::handle ( MsgStream s)
protected

local handler of UNKNOWN exceptions

Definition at line 44 of file Guards.cpp.

44  {
45  // the general printout
46  log << MSG::FATAL << "UNKNOWN exception is caught!" << endmsg;
47 }
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
Gaudi::Guards::ExceptionGuard::operator const StatusCode & ( ) const
inline

cast operator, useful for the implicit conversions

Definition at line 140 of file Guards.h.

140 { return code(); }
const StatusCode & code() const
the result of function evaluation
Definition: Guards.h:138
ExceptionGuard& Gaudi::Guards::ExceptionGuard::operator= ( const ExceptionGuard )
privatedelete

Member Data Documentation

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

status code : result of function evaluation

Definition at line 158 of file Guards.h.


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