GslSvc Class Reference

The implementation of IGslSvc interface. More...

#include <src/Components/GslSvc.h>

Inheritance diagram for GslSvc:

Collaboration diagram for GslSvc:

Public Member Functions
StatusCode	handle (const GslError &error) const override
	handle the GSL error More...
GslErrorHandler	handler () const override
	retrieve the current GSL error handler More...
GslErrorHandler	setHandler (GslErrorHandler handler) const override
	set new GSL error handler More...
StatusCode	status (const int error) const override
	transform GSL error code to Gaudi status code More...
StatusCode	initialize () override
	standard service initialization More...
StatusCode	finalize () override
	standard service finalization More...
	GslSvc (const std::string &name, ISvcLocator *svc)
	Standard constructor. More...
	~GslSvc () override=default
	destructor, virtual and protected More...
Public Member Functions inherited from extends< BASE, Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Types
typedef std::vector< std::string >	Names
	external handlers More...
typedef std::vector< IGslErrorHandler * >	Handlers

Private Member Functions
	GslSvc ()
	default constructor is private More...
	GslSvc (const GslSvc &)
	copy constructor is private More...
GslSvc &	operator= (const GslSvc &)
	assignment operator is private More...

Private Attributes
std::string	m_errorPolicy = "GSL"
	error policy More...
Names	m_handlersTypeNames
Handlers	m_handlers
std::vector< int >	m_ignore
	codes to be ignored More...

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

The implementation of IGslSvc interface.

The Gsl Service is teh service which perform intelligent error handling for GSL (GNU Scientific Library)

It provides a choice between different "Error Handling Policies"

Current implementation supports the several "error handling policies", which are driven by "ErrorPolicy" property of class GslSvc:

• "GSL": The simplest error policy, no action, the error hadling defined in GSL does not redefined
• "Off": The GSL empty error handling is used, what means the ignorance of all GSL errors. Program continues after any error, so the return values from any library routines must be checked. This policy is recommended by GSL team for production programs
• "Abort" The default GSL error policy, causes abort on error.
• "Ignore" The policy which is essentially the same as "Off", but performed with local error handler GslErrorHandlers::ignoreTheError
• "Exception" This policy throws the GaudiException with tag *GSL Error" to be thrown at the error. The policy implemented by local error handler GslErrorHandlers::throwException
• "Handle" The policy which uses the call back from local error handler GslErrorHandlers::handleTheError to IGslSvc::handle method. Current implementation of this method is sequential execution of declared handlers, defined through the property "Handlers" of class GslSvc in a format: GslSvc.Handlers = { "H1Type/H1Name" , "H2Type/H2Name" , "H3ype/3Name" }; The "handlers" must implement IGslErrorHandler interface The concrete handlers are provided in GaudiGSL package: class GslErorCount, GslErrorPrint and GslErrorException.

Attention

The error handling could be "turned off" for selected error codes (e.g. GSL_SUCCESS or GSL_CONTINUE ) using "IgnoreCodes" property. This feature is active only for "Handle" error policy.

See also

GslErrorHandlers

GslErrorHandlers::ingnoreTheError

GslErrorHandlers::throwException

GslErrorHandlers::handleTheError

IGslSvc

IGslErrorHandler

GslErrorCount

GslErrorPrint

GslErrorException

Author

Vanya Belyaev Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru

Date

29/04/2002

Definition at line 83 of file GslSvc.h.

Member Typedef Documentation

typedef std::vector<IGslErrorHandler*> GslSvc::Handlers

private

Definition at line 157 of file GslSvc.h.

typedef std::vector<std::string> GslSvc::Names

private

external handlers

Definition at line 155 of file GslSvc.h.

Constructor & Destructor Documentation

GslSvc::GslSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard constructor.

See also

Service

Parameters

name	service name
scv	pointer to service locator
name	service name
scv	pointer to service locator

Definition at line 38 of file GslSvc.cpp.

  : base_class ( name , svc )
{
  declareProperty( "ErrorPolicy" , m_errorPolicy       ) ;
  declareProperty( "Handlers"    , m_handlersTypeNames ) ;
  declareProperty( "IgnoreCodes" , m_ignore            ) ;
}

GslSvc::~GslSvc ( )

overridedefault

destructor, virtual and protected

GslSvc::GslSvc ( )

private

default constructor is private

GslSvc::GslSvc ( const GslSvc &  )

private

copy constructor is private

Member Function Documentation

StatusCode GslSvc::finalize ( )

override

standard service finalization

See also

Service

IGslSvc

IService

Returns

status code

See also

Service

IService

Returns

status code

Definition at line 140 of file GslSvc.cpp.

{
  MsgStream log(msgSvc(), name());
  log << MSG::DEBUG << "==> Finalize" << endmsg;

  // deactivate the static accessor to the service
  GaudiGSL::setGslSvc( nullptr );

  // finalize the base class
  return Service::finalize() ;
}

StatusCode GslSvc::handle ( const GslError &  error ) const

override

handle the GSL error

See also

IGslSvc

Parameters

err

error

Returns

status code

Parameters

error

error

Returns

status code

Definition at line 209 of file GslSvc.cpp.

{
  StatusCode sc = StatusCode::SUCCESS ;
  // code to be ignored?
  if( m_ignore.end() != std::find( m_ignore.begin () ,
                                   m_ignore.end   () ,
                                   error.code        ) ) { return sc ; }
  // invoke all handlers
  for( auto handler = m_handlers.begin() ;
       sc.isSuccess() && m_handlers.end() != handler ; ++handler )
    { sc = (*handler)->handle( error  ); }
  //
  return sc ;
}

IGslSvc::GslErrorHandler GslSvc::handler ( ) const

override

retrieve the current GSL error handler

See also

IGslSvc

Returns

current GSL error handler

current GSL error handler

Definition at line 158 of file GslSvc.cpp.

{
  GslErrorHandler hh = gsl_set_error_handler( nullptr );
  gsl_set_error_handler( hh );
  return hh ;
}

StatusCode GslSvc::initialize ( )

override

standard service initialization

See also

Service

IGslSvc

IService

Returns

status code

See also

Service

IService

Returns

status code

Prints the type of used handler get the handler

Get Tool Service

Definition at line 56 of file GslSvc.cpp.

{
  // initialize the base class
  StatusCode sc = Service::initialize();
  MsgStream log( msgSvc() , name() );
  if( sc.isFailure() )
    { log << MSG::ERROR
          << " Error in initialization of base class 'Service'"<< endmsg;
    return sc;
    }
  // activate the static accessor to the service
  GaudiGSL::setGslSvc( this );
  // set the error handlers
  if      ( "GSL"       == m_errorPolicy ) { /* nothing to do */ }
  else if ( "Off"       == m_errorPolicy )
    { gsl_set_error_handler_off()                                ; }
  else if ( "Abort"     == m_errorPolicy )
    { gsl_set_error_handler ( nullptr )                                ; }
  else if ( "Ignore"    == m_errorPolicy )
    { gsl_set_error_handler ( GslErrorHandlers::ignoreTheError ) ; }
  else if ( "Exception" == m_errorPolicy )
    { gsl_set_error_handler ( GslErrorHandlers::throwException ) ; }
  else if ( "Handle"    == m_errorPolicy )
    { gsl_set_error_handler ( GslErrorHandlers::handleTheError ) ; }
  else
    { log << MSG::ERROR
          << " Unknown Error policy '" << m_errorPolicy << "'"
          << " Valid policies: "
          << "[ 'GSL' , 'Off' , 'Abort' , 'Ignore' , 'Exception' , 'Handle' ]"
          << endmsg;
    return StatusCode::FAILURE ;
    }
  GslErrorHandler handler = gsl_set_error_handler( nullptr );
  gsl_set_error_handler( handler );
  if( handler )
    { log << MSG::VERBOSE
          << " GSL Error Handler is '"
          << System::typeinfoName( typeid(*handler) ) << "'"
          << endmsg; }
  else { log << MSG::INFO << " Error Handler is NULL" << endmsg ; }

  if( !m_handlersTypeNames.empty() )
    {
      auto  toolsvc = serviceLocator()->service<IToolSvc>("ToolSvc");
      if (!toolsvc) {
        log << MSG::ERROR << " Could not locate Tool Service! " << endmsg;
        return StatusCode::FAILURE;
      }
      for( const auto& it : m_handlersTypeNames )
        {
          auto pos = it.find('/');
          IGslErrorHandler* eh = nullptr ;
          if( pos != std::string::npos ) { 
              sc = toolsvc->retrieveTool
                ( it.substr( 0 , pos ), it.substr( pos + 1 ), eh , this ) ; 
          } else { 
              sc = toolsvc->retrieveTool( it , it , eh , this ) ; 
          }
          if( sc.isFailure() )
            { log << MSG::ERROR
                  << " Could not retrieve tool '" << it << "'"<< endmsg ;
            return sc ; }
          if( !eh )
            { log << MSG::ERROR
                  << " Could not retrieve tool '" << it << "'"<< endmsg ;
            return StatusCode::FAILURE  ; }
          m_handlers.push_back( eh );
        }
    }
  //
  return StatusCode::SUCCESS;
}

GslSvc& GslSvc::operator= ( const GslSvc &  )

private

assignment operator is private

IGslSvc::GslErrorHandler GslSvc::setHandler ( GslErrorHandler  handler ) const

override

set new GSL error handler

See also

IGslSvc

Parameters

handler

new GSL error handler

Returns

GSL error handler

Parameters

handler

new GSL error handler

Returns

GSL error handler

Definition at line 173 of file GslSvc.cpp.

{
  gsl_set_error_handler( handler );
  {
    MsgStream log( msgSvc(), name() );
    log << MSG::DEBUG << " New GSL handler is set '" ;
    if( !handler ) { log << "NULL"                                  ; }
    else           { log << System::typeinfoName( typeid(handler) ) ; }
    log << "'" << endmsg ;
  }
  return handler ;
}

StatusCode GslSvc::status ( const int  error ) const

override

transform GSL error code to Gaudi status code

See also

IGslSvc

Parameters

error

GLS error code

Returns

status code

Parameters

error

GLS error code

Returns

status code

Definition at line 193 of file GslSvc.cpp.

{
  if( GSL_SUCCESS == error ){ return StatusCode::SUCCESS ; }
  StatusCode sc( error );
  if( sc.isSuccess()       ){ return StatusCode::FAILURE ; }
  return sc ;
}

Member Data Documentation

std::string GslSvc::m_errorPolicy = "GSL"

private

error policy

Definition at line 152 of file GslSvc.h.

Handlers GslSvc::m_handlers

private

Definition at line 158 of file GslSvc.h.

Names GslSvc::m_handlersTypeNames

private

Definition at line 156 of file GslSvc.h.

std::vector<int> GslSvc::m_ignore

private

codes to be ignored

Definition at line 161 of file GslSvc.h.

---

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

• GaudiGSL/src/Components/GslSvc.h
• GaudiGSL/src/Components/GslSvc.cpp