AlgContextSvc Class Reference

#include <src/AlgContextSvc.h>

Inheritance diagram for AlgContextSvc:

Collaboration diagram for AlgContextSvc:

Public Member Functions
StatusCode	setCurrentAlg (IAlgorithm *a) override
	set the currently executing algorithm ("push_back") More...
StatusCode	unSetCurrentAlg (IAlgorithm *a) override
	remove the algorithm ("pop_back") More...
IAlgorithm *	currentAlg () const override
	accessor to current algorithm: More...
const IAlgContextSvc::Algorithms &	algorithms () const override
	get the stack of executed algorithms More...
void	handle (const Incident &) override
	handle incident More...
StatusCode	initialize () override
	standard initialization of the service More...
StatusCode	finalize () override
	standard finalization of the service More...
	AlgContextSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...
	~AlgContextSvc () override=default
	Standard Destructor. 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 Member Functions
	AlgContextSvc ()=delete
	AlgContextSvc (const AlgContextSvc &)=delete
AlgContextSvc &	operator= (const AlgContextSvc &)=delete

Private Attributes
IAlgContextSvc::Algorithms	m_algorithms
	the stack of current algorithms More...
SmartIF< IIncidentSvc >	m_inc = nullptr
	pointer to Incident Service More...
bool	m_check = true

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
typedef extends	base_class
	Typedef to this class. More...
typedef extend_interfaces< Interfaces...>	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extends	base_class
	Typedef to this class. More...
typedef extend_interfaces< Interfaces...>	extend_interfaces_base
	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

Definition at line 26 of file AlgContextSvc.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Instantiation of a static factory class used by clients to create instances of this service.

See also

Service

Definition at line 29 of file AlgContextSvc.cpp.

  : base_class ( name , svc  )
{
  declareProperty ( "Check" , m_check , "Flag to perform more checks" );
}

AlgContextSvc::~AlgContextSvc ( )

overridedefault

Standard Destructor.

AlgContextSvc::AlgContextSvc ( )

privatedelete

AlgContextSvc::AlgContextSvc ( const AlgContextSvc &  )

privatedelete

Member Function Documentation

const IAlgContextSvc::Algorithms& AlgContextSvc::algorithms ( ) const

inlineoverride

get the stack of executed algorithms

See also

IAlgContextSvc

Definition at line 36 of file AlgContextSvc.h.

  { return m_algorithms ; }

IAlgorithm * AlgContextSvc::currentAlg ( ) const

override

accessor to current algorithm:

See also

IAlgContextSvc

Definition at line 135 of file AlgContextSvc.cpp.

{ return m_algorithms.empty() ? nullptr : m_algorithms.back() ; }

StatusCode AlgContextSvc::finalize ( )

override

standard finalization of the service

See also

IService

Definition at line 74 of file AlgContextSvc.cpp.

{
  if ( !m_algorithms.empty() )
  {
    MsgStream log ( msgSvc() , name() ) ;
    log << MSG::WARNING
        << "Non-empty stack of algorithms #"
        << m_algorithms.size() << endmsg ;
  }
  // Incident Service
  if ( m_inc     )
  {
    m_inc -> removeListener ( this ) ;
    m_inc.reset();
  }
  // finalize the base class
  return Service::finalize () ;
}

void AlgContextSvc::handle ( const Incident &  )

override

handle incident

See also

IIncidentListener

Definition at line 140 of file AlgContextSvc.cpp.

{
  if ( !m_algorithms.empty() )
  {
    MsgStream log ( msgSvc() , name() ) ;
    log << MSG::ERROR
        << "Non-empty stack of algorithms #"
        << m_algorithms.size() << endmsg ;
  }
}

StatusCode AlgContextSvc::initialize ( )

override

standard initialization of the service

See also

IService

Definition at line 38 of file AlgContextSvc.cpp.

{
  // Initialize the base class
  StatusCode sc = Service::initialize () ;
  if ( sc.isFailure () ) { return sc ; }
  // Incident Service
  if ( m_inc     )
  {
    m_inc -> removeListener ( this ) ;
    m_inc.reset();
  }
  // perform more checks?
  if ( m_check )
  {
    m_inc = Service::service ( "IncidentSvc" , true ) ;
    if ( !m_inc )
    {
      MsgStream log ( msgSvc() , name() )  ;
      log << MSG::ERROR << "Could not locate 'IncidentSvc'" << endmsg ;
      return StatusCode::FAILURE ;                                               // RETURN
    }
    m_inc -> addListener ( this , IncidentType::BeginEvent ) ;
    m_inc -> addListener ( this , IncidentType::EndEvent   ) ;
  }
  if ( !m_algorithms.empty() )
  {
    MsgStream log ( msgSvc() , name() ) ;
    log << MSG::WARNING
        << "Non-empty stack of algorithms #"
        << m_algorithms.size() << endmsg ;
  }
  return StatusCode::SUCCESS ;
}

AlgContextSvc& AlgContextSvc::operator= ( const AlgContextSvc &  )

privatedelete

StatusCode AlgContextSvc::setCurrentAlg ( IAlgorithm *  a )

override

set the currently executing algorithm ("push_back")

See also

IAlgContextSvc

Definition at line 95 of file AlgContextSvc.cpp.

{
  if ( !a )
  {
    MsgStream log ( msgSvc() , name() ) ;
    log << MSG::WARNING << "IAlgorithm* points to NULL" << endmsg ;
    //
    return StatusCode::RECOVERABLE ;                              // RETURN
  }
  m_algorithms.push_back ( a ) ;
  //
  return StatusCode::SUCCESS ;                                    // RETURN
}

StatusCode AlgContextSvc::unSetCurrentAlg ( IAlgorithm *  a )

override

remove the algorithm ("pop_back")

See also

IAlgContextSvc

Definition at line 111 of file AlgContextSvc.cpp.

{
  if ( !a )
  {
    MsgStream log ( msgSvc() , name() ) ;
    log << MSG::WARNING << "IAlgorithm* points to NULL" << endmsg ;
    //
    return StatusCode::RECOVERABLE ;                              // RETURN
  }
  if ( m_algorithms.empty() || m_algorithms.back() != a )
  {
    MsgStream log ( msgSvc() , name() ) ;
    log << MSG::ERROR << "Algorithm stack is invalid" << endmsg ;
    //
    return StatusCode::FAILURE ;
  }
  //
  m_algorithms.pop_back() ;                                      // POP_BACK
  //
  return StatusCode::SUCCESS ;
}

Member Data Documentation

IAlgContextSvc::Algorithms AlgContextSvc::m_algorithms

private

the stack of current algorithms

Definition at line 60 of file AlgContextSvc.h.

bool AlgContextSvc::m_check = true

private

Definition at line 64 of file AlgContextSvc.h.

SmartIF<IIncidentSvc> AlgContextSvc::m_inc = nullptr

private

pointer to Incident Service

Definition at line 62 of file AlgContextSvc.h.

---

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

• GaudiCommonSvc/src/AlgContextSvc.h
• GaudiCommonSvc/src/AlgContextSvc.cpp