#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< Service, IAlgContextSvc, IIncidentListener >
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 Service
const std::string &	name () const override
	Retrieve name of the service. More...

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. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

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

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

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

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

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

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

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

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

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

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

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

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

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

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

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

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

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

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

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

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

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
	AlgContextSvc ()=delete

	AlgContextSvc (const AlgContextSvc &)=delete

AlgContextSvc &	operator= (const AlgContextSvc &)=delete

Private Attributes
boost::thread_specific_ptr< 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< Service, IAlgContextSvc, IIncidentListener >
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 Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

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

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...

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

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

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

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

Detailed Description

Definition at line 28 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 40 of file AlgContextSvc.h.

41 { return *m_algorithms ; }

AlgContextSvc::m_algorithms

boost::thread_specific_ptr< IAlgContextSvc::Algorithms > m_algorithms

the stack of current algorithms

Definition: AlgContextSvc.h:64

IAlgorithm * AlgContextSvc::currentAlg ( ) const

override

accessor to current algorithm:

See also: IAlgContextSvc

Definition at line 134 of file AlgContextSvc.cpp.

 {
   return (m_algorithms.get() && ! m_algorithms->empty())
     ? m_algorithms->back()
     : nullptr;
 }

StatusCode AlgContextSvc::finalize ( )

override

standard finalization of the service

See also: IService

Definition at line 71 of file AlgContextSvc.cpp.

 {
   if ( m_algorithms.get() && !m_algorithms->empty() )
   {
     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 143 of file AlgContextSvc.cpp.

                                              {
   if ( m_algorithms.get() && !m_algorithms->empty() ) {
     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 )
     {
       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.get() && !m_algorithms->empty() )
   {
     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 90 of file AlgContextSvc.cpp.

 {
   if ( !a )
   {
     warning() << "IAlgorithm* points to NULL" << endmsg ;
     return StatusCode::RECOVERABLE ;                              // RETURN
   }
   // check whether thread-local algorithm list already exists
   // if not, create it
   if ( ! m_algorithms.get()) {
     m_algorithms.reset( new IAlgContextSvc::Algorithms() );
   }
   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 109 of file AlgContextSvc.cpp.

 {
   // check whether thread-local algorithm list already exists
   // if not, create it
   if ( ! m_algorithms.get()) {
     m_algorithms.reset( new IAlgContextSvc::Algorithms() );
   }
 
   if ( !a )
   {
     warning() << "IAlgorithm* points to NULL" << endmsg ;
     return StatusCode::RECOVERABLE ;                              // RETURN
   }
     if ( m_algorithms->empty() || m_algorithms->back() != a )
    {
     error() << "Algorithm stack is invalid" << endmsg ;
     return StatusCode::FAILURE ;
   }
   m_algorithms->pop_back() ;                                      // POP_BACK
 
   return StatusCode::SUCCESS ;
 }

Member Data Documentation

boost::thread_specific_ptr<IAlgContextSvc::Algorithms> AlgContextSvc::m_algorithms

private

the stack of current algorithms

Definition at line 64 of file AlgContextSvc.h.

bool AlgContextSvc::m_check = true

private

Definition at line 68 of file AlgContextSvc.h.

SmartIF<IIncidentSvc> AlgContextSvc::m_inc = nullptr

private

pointer to Incident Service

Definition at line 66 of file AlgContextSvc.h.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation