Simple implementation of IExceptionSvc abstract interface. More...

#include </builds/gaudi/Gaudi/GaudiMonitor/src/ExceptionSvc.h>

Inheritance diagram for ExceptionSvc:

[legend]

Collaboration diagram for ExceptionSvc:

[legend]

Public Member Functions
StatusCode	handle (const INamedInterface &o, const GaudiException &e) const override
	Handle caught GaudiExceptions.

StatusCode	handle (const INamedInterface &o, const std::exception &e) const override
	Handle caught std::exceptions.

StatusCode	handle (const INamedInterface &o) const override
	Handle caught (unknown)exceptions.

StatusCode	handleErr (const INamedInterface &o, const StatusCode &s) const override
	Handle errors.

StatusCode	initialize () override
	initialize the service

Public Member Functions inherited from extends< Service, IExceptionSvc >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Private Types
enum	Policy { ALL , NONE }

enum	ReturnState { SUCCESS , FAILURE , RECOVERABLE , RETHROW , DEFAULT }

Private Member Functions
	ExceptionSvc ()=delete
	no default constructor

	ExceptionSvc (const ExceptionSvc &)=delete

ExceptionSvc &	operator= (const ExceptionSvc &)=delete

virtual StatusCode	process (const INamedInterface &o) const

Private Attributes
Policy	m_mode_exc = ALL

Policy	m_mode_err = NONE

std::map< std::string, ReturnState >	m_retCodesExc

std::map< std::string, ReturnState >	m_retCodesErr

Gaudi::Property< std::string >	m_mode_exc_s { this, "Catch", "ALL" }

Gaudi::Property< std::string >	m_mode_err_s { this, "Errors", "NONE" }

Additional Inherited Members
Public Types inherited from extends< Service, IExceptionSvc >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

Simple implementation of IExceptionSvc abstract interface.

Author: (1) ATLAS collaboration; (2) modified by Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-03-08

Definition at line 28 of file ExceptionSvc.h.

Member Enumeration Documentation

◆ Policy

enum ExceptionSvc::Policy

private

Enumerator
ALL
NONE

Definition at line 56 of file ExceptionSvc.h.

56{ ALL, NONE };

ExceptionSvc::ALL

@ ALL

Definition ExceptionSvc.h:56

ExceptionSvc::NONE

@ NONE

Definition ExceptionSvc.h:56

◆ ReturnState

enum ExceptionSvc::ReturnState

private

Enumerator
SUCCESS
FAILURE
RECOVERABLE
RETHROW
DEFAULT

Definition at line 57 of file ExceptionSvc.h.

57{ SUCCESS, FAILURE, RECOVERABLE, RETHROW, DEFAULT };

ExceptionSvc::RETHROW

@ RETHROW

Definition ExceptionSvc.h:57

ExceptionSvc::FAILURE

@ FAILURE

Definition ExceptionSvc.h:57

ExceptionSvc::SUCCESS

@ SUCCESS

Definition ExceptionSvc.h:57

ExceptionSvc::RECOVERABLE

@ RECOVERABLE

Definition ExceptionSvc.h:57

ExceptionSvc::DEFAULT

@ DEFAULT

Definition ExceptionSvc.h:57

Constructor & Destructor Documentation

◆ ExceptionSvc() [1/2]

ExceptionSvc::ExceptionSvc ( )

privatedelete

no default constructor

◆ ExceptionSvc() [2/2]

ExceptionSvc::ExceptionSvc ( const ExceptionSvc & )

privatedelete

Member Function Documentation

◆ handle() [1/3]

StatusCode ExceptionSvc::handle ( const INamedInterface & o ) const

override

Handle caught (unknown)exceptions.

Handle caught exceptions

Definition at line 206 of file ExceptionSvc.cpp.

                                                                  {
  if ( msgLevel( MSG::DEBUG ) ) debug() << "Handling unknown exception for " << alg.name() << endmsg;
  return process( alg );
}

◆ handle() [2/3]

StatusCode ExceptionSvc::handle	(	const INamedInterface &	o,
		const GaudiException &	e ) const

override

Handle caught GaudiExceptions.

Handle caught exceptions

Definition at line 218 of file ExceptionSvc.cpp.

                                                                                             {
  if ( msgLevel( MSG::DEBUG ) ) debug() << "Handling GaudiException: \"" << exc << "\" for " << alg.name() << endmsg;
  return process( alg );
}

◆ handle() [3/3]

StatusCode ExceptionSvc::handle	(	const INamedInterface &	o,
		const std::exception &	e ) const

override

Handle caught std::exceptions.

Handle caught exceptions

Definition at line 212 of file ExceptionSvc.cpp.

                                                                                           {
  if ( msgLevel( MSG::DEBUG ) ) debug() << "Handling std:except: \"" << exc.what() << "\" for " << alg.name() << endmsg;
  return process( alg );
}

◆ handleErr()

StatusCode ExceptionSvc::handleErr	(	const INamedInterface &	o,
		const StatusCode &	s ) const

override

Handle errors.

Handle errors

Definition at line 149 of file ExceptionSvc.cpp.

                                                                                           {
  if ( msgLevel( MSG::DEBUG ) ) debug() << "Handling Error from " << alg.name() << endmsg;
 
  // is this Alg special?
  auto i = m_retCodesErr.find( alg.name() );
  if ( i != m_retCodesErr.end() ) {
    switch ( i->second ) {
    case SUCCESS:
      return StatusCode::SUCCESS;
    case FAILURE:
      return StatusCode::FAILURE;
    case RECOVERABLE:
      return StatusCode::RECOVERABLE;
    // should never get here
    case RETHROW:
      break;
    case DEFAULT:
      break;
    }
 
  } else {
 
    if ( m_mode_err == ALL ) return StatusCode::FAILURE; // turn it into FAILURE
    assert( m_mode_err == NONE );
    // don't touch the return code
    return st;
  }
  return StatusCode::FAILURE;
}

◆ initialize()

StatusCode ExceptionSvc::initialize ( )

override

initialize the service

Definition at line 40 of file ExceptionSvc.cpp.

                                    {
  StatusCode status = Service::initialize();
  if ( status.isFailure() ) { return status; }
 
  string key = m_mode_exc_s.value();
 
  auto        loc  = key.find( " " );
  std::string mode = key.substr( 0, loc );
 
  toupper( mode );
 
  if ( mode == "NONE" ) {
    m_mode_exc = NONE;
  } else if ( mode == "ALL" ) {
    m_mode_exc = ALL;
  } else {
    error() << "Unknown mode for Exception handling: \"" << mode << "\". Default must be one of \"ALL\" or \"NONE\""
            << endmsg;
    m_state = Gaudi::StateMachine::OFFLINE;
    return StatusCode::FAILURE;
  }
 
  if ( loc == string::npos ) {
    key.clear();
  } else {
    key = key.substr( loc + 1 );
  }
 
  std::string VAL, TAG;
 
  static const boost::regex exp{ "[[:space:]]*([^[:space:]]+)[[:space:]]*=[[:space:]]*([^[:space:]]+)" };
  static const auto         tok_end = boost::sregex_iterator();
  for ( auto tok_iter = boost::sregex_iterator( begin( key ), end( key ), exp ); tok_iter != tok_end; ++tok_iter ) {
    TAG = ( *tok_iter )[1];
    VAL = ( *tok_iter )[2];
    toupper( VAL );
 
    if ( VAL == "SUCCESS" ) {
      m_retCodesExc[TAG] = SUCCESS;
    } else if ( VAL == "FAILURE" ) {
      m_retCodesExc[TAG] = FAILURE;
    } else if ( VAL == "REVOVERABLE" ) {
      m_retCodesExc[TAG] = RECOVERABLE;
    } else if ( VAL == "RETHROW" ) {
      m_retCodesExc[TAG] = RETHROW;
    } else if ( VAL == "DEFAULT" ) {
      m_retCodesExc[TAG] = DEFAULT;
    } else {
      error() << "In JobOpts: unknown return code \"" << VAL << "\" for Algorithm " << TAG << std::endl
              << "   Must be one of: DEFAULT, SUCCESS, FAILURE, RECOVERABLE, RETHROW" << endmsg;
      m_state = Gaudi::StateMachine::OFFLINE;
      return StatusCode::FAILURE;
    }
 
    if ( msgLevel( MSG::DEBUG ) )
      debug() << "Will catch exceptions thrown by: " << TAG << " -> action: " << VAL << endmsg;
  }
 
  // now process errors
  key = m_mode_err_s.value();
 
  loc  = key.find( " " );
  mode = key.substr( 0, loc );
 
  toupper( mode );
 
  if ( mode == "NONE" ) {
    m_mode_err = NONE;
  } else if ( mode == "ALL" ) {
    m_mode_err = ALL;
  } else {
    error() << "Unknown mode for Error handling: \"" << mode << "\". Default must be one of \"ALL\" or \"NONE\""
            << endmsg;
    m_state = Gaudi::StateMachine::OFFLINE;
    return StatusCode::FAILURE;
  }
 
  if ( loc == string::npos ) {
    key.clear();
  } else {
    key = key.substr( loc + 1 );
  }
 
  for ( auto tok_iter = boost::sregex_iterator( begin( key ), end( key ), exp ); tok_iter != tok_end; ++tok_iter ) {
    TAG = ( *tok_iter )[1];
    VAL = ( *tok_iter )[2];
    toupper( VAL );
 
    if ( VAL == "SUCCESS" ) {
      m_retCodesErr[TAG] = SUCCESS;
    } else if ( VAL == "FAILURE" ) {
      m_retCodesErr[TAG] = FAILURE;
    } else if ( VAL == "RECOVERABLE" ) {
      m_retCodesErr[TAG] = RECOVERABLE;
    } else {
      error() << "In JobOpts: unknown return code \"" << VAL << "\" for Algorithm " << TAG << std::endl
              << "   Must be one of: SUCCESS, FAILURE, RECOVERABLE" << endmsg;
      m_state = Gaudi::StateMachine::OFFLINE;
      return StatusCode::FAILURE;
    }
 
    if ( msgLevel( MSG::DEBUG ) )
      debug() << "Will process Errors returned by: " << TAG << " -> action: " << VAL << endmsg;
  }
  return status;
}

◆ operator=()

ExceptionSvc & ExceptionSvc::operator= ( const ExceptionSvc & )

privatedelete

◆ process()

StatusCode ExceptionSvc::process ( const INamedInterface & o ) const

privatevirtual

Definition at line 180 of file ExceptionSvc.cpp.

                                                                   {
 
  // is this Alg special?
  auto i = m_retCodesExc.find( alg.name() );
  if ( i != m_retCodesExc.end() ) {
 
    switch ( i->second ) {
    case DEFAULT:
      return StatusCode::FAILURE; // there is no default
    case SUCCESS:
      return StatusCode::SUCCESS;
    case FAILURE:
      return StatusCode::FAILURE;
    case RECOVERABLE:
      return StatusCode::RECOVERABLE;
    case RETHROW:
      throw; // cppcheck-suppress rethrowNoCurrentException
    }
  }
 
  if ( m_mode_exc == ALL ) { throw; } // cppcheck-suppress rethrowNoCurrentException
  assert( m_mode_exc == NONE );
  return StatusCode::FAILURE;
}

Member Data Documentation

◆ m_mode_err

Policy ExceptionSvc::m_mode_err = NONE

private

Definition at line 59 of file ExceptionSvc.h.

◆ m_mode_err_s

Gaudi::Property<std::string> ExceptionSvc::m_mode_err_s { this, "Errors", "NONE" }

private

Definition at line 63 of file ExceptionSvc.h.

63{ this, "Errors", "NONE" };

◆ m_mode_exc

Policy ExceptionSvc::m_mode_exc = ALL

private

Definition at line 59 of file ExceptionSvc.h.

◆ m_mode_exc_s

Gaudi::Property<std::string> ExceptionSvc::m_mode_exc_s { this, "Catch", "ALL" }

private

Definition at line 62 of file ExceptionSvc.h.

62{ this, "Catch", "ALL" };

◆ m_retCodesErr

std::map<std::string, ReturnState> ExceptionSvc::m_retCodesErr

private

Definition at line 60 of file ExceptionSvc.h.

◆ m_retCodesExc

std::map<std::string, ReturnState> ExceptionSvc::m_retCodesExc

private

Definition at line 60 of file ExceptionSvc.h.

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

GaudiMonitor/src/ExceptionSvc.h
GaudiMonitor/src/ExceptionSvc.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Policy

◆ ReturnState

Constructor & Destructor Documentation

◆ ExceptionSvc() [1/2]

◆ ExceptionSvc() [2/2]

Member Function Documentation

◆ handle() [1/3]

◆ handle() [2/3]

◆ handle() [3/3]

◆ handleErr()

◆ initialize()

◆ operator=()

◆ process()

Member Data Documentation

◆ m_mode_err

◆ m_mode_err_s

◆ m_mode_exc

◆ m_mode_exc_s

◆ m_retCodesErr

◆ m_retCodesExc