#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/Service.h>

Inheritance diagram for Service:

[legend]

Collaboration diagram for Service:

[legend]

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

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

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

Public Member Functions
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...

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

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator 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 >
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. More...

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

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

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

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

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

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

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

	~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 > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

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

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

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

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

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

Private Member Functions
void	initToolHandles () const

void	sysInitialize_imp ()

void	setServiceManager (ISvcManager *ism) override

Private Attributes
StatusCode	m_initSC

std::once_flag	m_initFlag

std::string	m_name
	Service Name More...

SmartIF< ISvcLocator >	m_svcLocator
	Service Locator reference More...

SmartIF< ISvcManager >	m_svcManager

std::vector< IAlgTool * >	m_tools

std::vector< BaseToolHandle * >	m_toolHandles

std::vector< GaudiHandleArrayBase * >	m_toolHandleArrays

bool	m_toolHandlesInit = false

Friends
class	ServiceManager

Detailed Description

Base class for all services. It implements the IService and IProperty interfaces.

Author: Pere Mato; Marco Clemencic

Definition at line 46 of file Service.h.

Member Typedef Documentation

◆ Factory

using Service::Factory = Gaudi::PluginService::Factory<IService*( const std::string&, ISvcLocator* )>

Definition at line 48 of file Service.h.

Constructor & Destructor Documentation

◆ Service()

Service::Service	(	std::string	name,
		ISvcLocator *	svcloc
	)

Standard Constructor

Definition at line 339 of file Service.cpp.

                                                       : m_name( std::move( name ) ), m_svcLocator( svcloc ) {
   if ( m_name != "MessageSvc" ) { // the MessageSvc should not notify itself
     m_outputLevel.declareUpdateHandler(
         [this]( Gaudi::Details::PropertyBase& ) { this->updateMsgStreamOutputLevel( this->m_outputLevel ); } );
   }
  
   // Initialize the default value from ApplicationMgr AuditAlgorithms
   Gaudi::Property<bool> audit( false );
   auto                  appMgr = serviceLocator()->service<IProperty>( "ApplicationMgr" );
   if ( appMgr && appMgr->hasProperty( "AuditServices" ) ) { audit.assign( appMgr->getProperty( "AuditServices" ) ); }
   m_auditInit           = audit;
   m_auditorInitialize   = audit;
   m_auditorStart        = audit;
   m_auditorStop         = audit;
   m_auditorFinalize     = audit;
   m_auditorReinitialize = audit;
   m_auditorRestart      = audit;
 }

◆ ~Service()

Service::~Service ( )

overrideprotected

Standard Destructor

Definition at line 29 of file Service.cpp.

                   {
   if ( m_svcManager ) m_svcManager->removeService( this ).ignore();
 }

Member Function Documentation

◆ addToolsArray()

template<class T >

void Service::addToolsArray ( ToolHandleArray< T > & hndlArr )

inline

Definition at line 179 of file Service.h.

                                                     {
     m_toolHandleArrays.push_back( &hndlArr );
   }

◆ auditorSvc()

SmartIF< IAuditorSvc > & Service::auditorSvc ( ) const

The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Definition at line 358 of file Service.cpp.

                                                 {
   if ( !m_pAuditorSvc ) {
     m_pAuditorSvc = serviceLocator()->service( "AuditorSvc" );
     if ( !m_pAuditorSvc ) { throw GaudiException( "Service [AuditorSvc] not found", name(), StatusCode::FAILURE ); }
   }
   return m_pAuditorSvc;
 }

◆ configure()

StatusCode Service::configure ( )

inlineoverride

Definition at line 56 of file Service.h.

56 { return StatusCode::SUCCESS; }

◆ declareProperty() [1/2]

template<class T >

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

inline

Definition at line 137 of file Service.h.

                                                                                  {
     this->declareTool( hndl, hndl.typeAndName() ).ignore();
     return PropertyHolderImpl::declareProperty( name, hndl, doc );
   }

◆ declareProperty() [2/2]

template<class T >

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

inline

Definition at line 172 of file Service.h.

                                                                                  {
     addToolsArray( hndlArr );
     return PropertyHolderImpl::declareProperty( name, hndlArr, doc );
   }

◆ declareTool() [1/2]

template<class T >

StatusCode Service::declareTool	(	ToolHandle< T > &	handle,
		bool	createIf = `true`
	)

inline

Definition at line 144 of file Service.h.

                                                                         {
     return this->declareTool( handle, handle.typeAndName(), createIf );
   }

◆ declareTool() [2/2]

template<class T >

StatusCode Service::declareTool	(	ToolHandle< T > &	handle,
		const std::string &	toolTypeAndName,
		bool	createIf = `true`
	)

inline

Declare used tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 156 of file Service.h.

                                                                                                           {
  
     StatusCode sc = handle.initialize( toolTypeAndName, handle.isPublic() ? nullptr : this, createIf );
     if ( !sc ) {
       throw GaudiException{ std::string{ "Cannot create handle for " } + ( handle.isPublic() ? "public" : "private" ) +
                                 " tool " + toolTypeAndName,
                             name(), sc };
     }
  
     m_toolHandles.push_back( &handle );
  
     return sc;
   }

◆ finalize()

StatusCode Service::finalize ( )

override

Definition at line 222 of file Service.cpp.

                              {
   // m_state = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::TERMINATE,m_state);
   return StatusCode::SUCCESS;
 }

◆ FSMState()

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

inlineoverride

Definition at line 62 of file Service.h.

62 { return m_state; }

◆ initialize()

StatusCode Service::initialize ( )

override

Definition at line 118 of file Service.cpp.

                                {
   ON_DEBUG debug() << "Service base class initialized successfully" << endmsg;
   m_state = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::CONFIGURE, m_state );
   return StatusCode::SUCCESS;
 }

◆ initToolHandles()

void Service::initToolHandles ( ) const

private

Definition at line 368 of file Service.cpp.

                                     {
   auto init_one = [&]( BaseToolHandle* th ) {
     if ( !th->isEnabled() ) {
       if ( msgLevel( MSG::DEBUG ) && !th->typeAndName().empty() )
         debug() << "ToolHandle " << th->typeAndName() << " not used" << endmsg;
       return;
     }
     if ( !th->get() ) {
       auto sc = th->retrieve();
       if ( sc.isFailure() ) {
         throw GaudiException( "Failed to retrieve tool " + th->typeAndName(), this->name(), StatusCode::FAILURE );
       }
     }
     auto* tool = th->get();
     if ( msgLevel( MSG::DEBUG ) )
       debug() << "Adding " << ( th->isPublic() ? "public" : "private" ) << " ToolHandle tool " << tool->name() << " ("
               << tool->type() << ")" << endmsg;
     m_tools.push_back( tool );
   };
  
   for ( auto thArr : m_toolHandleArrays ) {
     if ( msgLevel( MSG::DEBUG ) )
       debug() << "Registering all Tools in ToolHandleArray " << thArr->propertyName() << endmsg;
     // Iterate over its tools:
     for ( auto toolHandle : thArr->getBaseArray() ) {
       // Try to cast it into a BaseToolHandle pointer:
       BaseToolHandle* bth = dynamic_cast<BaseToolHandle*>( toolHandle );
       if ( bth ) {
         init_one( bth );
       } else {
         error() << "Error retrieving Tool " << toolHandle->typeAndName() << " in ToolHandleArray "
                 << thArr->propertyName() << ". Not registered" << endmsg;
       }
     }
   }
  
   for ( BaseToolHandle* th : m_toolHandles ) init_one( th );
  
   m_toolHandlesInit = true;
 }

◆ name()

const std::string & Service::name ( ) const

override

Retrieve name of the service

Definition at line 332 of file Service.cpp.

332 { return m_name; }

◆ outputLevel()

int Service::outputLevel ( ) const

inlineprotected

get the Service's output level

Definition at line 208 of file Service.h.

208 { return m_outputLevel.value(); }

◆ reinitialize()

StatusCode Service::reinitialize ( )

override

Definition at line 295 of file Service.cpp.

                                  {
   /* @TODO
    * MCl 2008-10-23: the implementation of reinitialize as finalize+initialize
    *                 is causing too many problems
    *
   // Default implementation is finalize+initialize
   StatusCode sc = finalize();
   if (sc.isFailure()) {
     error() << "reinitialize(): cannot be finalized" << endmsg;
     return sc;
   }
   sc = initialize();
   if (sc.isFailure()) {
     error() << "reinitialize(): cannot be initialized" << endmsg;
     return sc;
   }
   */
   return StatusCode::SUCCESS;
 }

◆ restart()

StatusCode Service::restart ( )

override

Definition at line 316 of file Service.cpp.

                             {
   // Default implementation is stop+start
   StatusCode sc = stop();
   if ( sc.isFailure() ) {
     error() << "restart(): cannot be stopped" << endmsg;
     return sc;
   }
   sc = start();
   if ( sc.isFailure() ) {
     error() << "restart(): cannot be started" << endmsg;
     return sc;
   }
   return StatusCode::SUCCESS;
 }

◆ service() [1/4]

template<typename IFace = IService>

SmartIF<IFace> Service::service	(	const std::string &	name,
		bool	createIf = `true`
	)		const

inline

Definition at line 117 of file Service.h.

                                                                               {
     return ServiceLocatorHelper( *serviceLocator(), *this )
         .service<IFace>( name, !createIf, // quiet
                          createIf );
   }

◆ service() [2/4]

template<class T >

StatusCode Service::service	(	const std::string &	name,
		const T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 89 of file Service.h.

                                                                                {
     ISvcLocator& svcLoc = *serviceLocator();
     auto         ptr    = ServiceLocatorHelper( svcLoc, *this )
                    .service<T>( name, !createIf, // quiet
                                 createIf );
     if ( ptr ) {
       psvc = ptr.get();
       const_cast<T*>( psvc )->addRef();
       return StatusCode::SUCCESS;
     }
     // else
     psvc = nullptr;
     return StatusCode::FAILURE;
   }

◆ service() [3/4]

template<class T >

StatusCode Service::service	(	const std::string &	name,
		T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Definition at line 106 of file Service.h.

                                                                          {
     auto ptr = service<T>( name, createIf );
     psvc     = ( ptr ? ptr.get() : nullptr );
     if ( psvc ) {
       psvc->addRef();
       return StatusCode::SUCCESS;
     }
     return StatusCode::FAILURE;
   }

◆ service() [4/4]

template<class T >

StatusCode Service::service	(	const std::string &	svcType,
		const std::string &	svcName,
		T *&	psvc
	)		const

inline

Access a service by name and type, creating it if it doesn't already exist.

Definition at line 127 of file Service.h.

                                                                                 {
     return service( svcType + "/" + svcName, psvc );
   }

◆ serviceLocator()

SmartIF< ISvcLocator > & Service::serviceLocator ( ) const

override

Retrieve pointer to service locator

Definition at line 335 of file Service.cpp.

335 { return m_svcLocator; }

◆ setServiceManager()

void Service::setServiceManager ( ISvcManager * ism )

overrideprivate

Definition at line 366 of file Service.cpp.

366 { m_svcManager = ism; }

◆ start()

StatusCode Service::start ( )

override

Definition at line 187 of file Service.cpp.

                           {
   // stub implementation
   return StatusCode::SUCCESS;
 }

◆ stop()

StatusCode Service::stop ( )

override

Definition at line 181 of file Service.cpp.

                          {
   // stub implementation
   return StatusCode::SUCCESS;
 }

◆ sysFinalize()

StatusCode Service::sysFinalize ( )

override

Finalize Service

Definition at line 193 of file Service.cpp.

                                 {
  
   StatusCode sc( StatusCode::FAILURE );
  
   try {
     m_targetState = Gaudi::StateMachine::OFFLINE;
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        ( m_auditorFinalize ) ? auditorSvc().get() : nullptr, IAuditor::Finalize );
     sc = finalize();
     if ( sc.isSuccess() ) m_state = m_targetState;
   } catch ( const GaudiException& Exception ) {
     fatal() << " Exception with tag=" << Exception.tag() << " is caught " << endmsg;
     error() << Exception << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() ) ;
   } catch ( const std::exception& Exception ) {
     fatal() << " Standard std::exception is caught " << endmsg;
     error() << Exception.what() << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" ) ;
   } catch ( ... ) {
     fatal() << "UNKNOWN Exception is caught " << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
  
   m_pAuditorSvc = nullptr;
   return sc;
 }

◆ sysInitialize()

StatusCode Service::sysInitialize ( )

override

Initialize Service

Definition at line 34 of file Service.cpp.

                                   {
   std::call_once( m_initFlag, &Service::sysInitialize_imp, this );
   return m_initSC;
 }

◆ sysInitialize_imp()

void Service::sysInitialize_imp ( )

private

Definition at line 39 of file Service.cpp.

                                 {
  
   try {
     m_targetState = Gaudi::StateMachine::INITIALIZED;
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        ( m_auditorInitialize ) ? auditorSvc().get() : nullptr, IAuditor::Initialize );
  
     // initialize messaging (except for MessageSvc)
     if ( name() != "MessageSvc" ) {
       // this initializes the messaging, in case property update handlers need to print
       // and update the property value bypassing the update handler
       m_outputLevel.value() = setUpMessaging();
     }
  
     bindPropertiesTo( serviceLocator()->getOptsSvc() );
  
     if ( m_checkToolDeps && !m_autoRetrieveTools ) {
       error() << "Property AutoRetrieveTools must be set TRUE if CheckToolDeps is True" << endmsg;
       m_initSC = StatusCode::FAILURE;
       return;
     }
  
     m_initSC = initialize(); // This should change the state to Gaudi::StateMachine::CONFIGURED
  
     // Check for data dependencies in AlgTools
     // visit all sub-algs and tools, build full set. First initialize ToolHandles if needed
     if ( m_autoRetrieveTools ) {
       try {
         if ( !m_toolHandlesInit ) initToolHandles();
       } catch ( const GaudiException& Exception ) {
         error() << "Service failed to initilize ToolHandles : " << Exception << endmsg;
         m_initSC = StatusCode::FAILURE;
         return;
       }
  
       if ( m_checkToolDeps ) {
         for ( auto& itool : m_tools ) {
           info() << "  AlgTool: " << itool->name() << endmsg;
           IDataHandleHolder* idh = dynamic_cast<IDataHandleHolder*>( itool );
           if ( idh == 0 ) {
             error() << "dcast to IDataHandleHolder failed" << endmsg;
             continue;
           }
           if ( idh->inputDataObjs().size() != 0 ) {
             error() << "Service " << name() << " holds AlgTool " << itool->name()
                     << " which holds at least one ReadDataHandle" << endmsg;
             for ( auto& obj : idh->inputDataObjs() ) { error() << "   -> InputHandle:  " << obj << endmsg; }
             m_initSC = StatusCode::FAILURE;
           }
           if ( idh->outputDataObjs().size() != 0 ) {
             error() << "Service " << name() << " holds AlgTool " << itool->name()
                     << " which holds at least one WriteDataHandle" << endmsg;
             for ( auto& obj : idh->outputDataObjs() ) { error() << "   -> OutputHandle: " << obj << endmsg; }
             m_initSC = StatusCode::FAILURE;
           }
         }
       }
     }
  
     if ( m_initSC.isSuccess() ) m_state = m_targetState;
     return;
   } catch ( const GaudiException& Exception ) {
     fatal() << "in sysInitialize(): exception with tag=" << Exception.tag() << " is caught" << endmsg;
     error() << Exception << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() );
   } catch ( const std::exception& Exception ) {
     fatal() << "in sysInitialize(): standard std::exception is caught" << endmsg;
     error() << Exception.what() << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" );
   } catch ( ... ) {
     fatal() << "in sysInitialize(): UNKNOWN Exception is caught" << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
  
   m_initSC = StatusCode::FAILURE;
 }

◆ sysReinitialize()

StatusCode Service::sysReinitialize ( )

override

Re-initialize the Service.

Definition at line 228 of file Service.cpp.

                                     {
  
   StatusCode sc;
  
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::INITIALIZED != FSMState() ) {
     error() << "sysReinitialize(): cannot reinitialize service not initialized" << endmsg;
     return StatusCode::FAILURE;
   }
  
   try {
  
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        ( m_auditorReinitialize ) ? auditorSvc().get() : nullptr,
                                        IAuditor::ReInitialize );
     sc = reinitialize();
     return sc;
   } catch ( const GaudiException& Exception ) {
     fatal() << " Exception with tag=" << Exception.tag() << " is caught " << endmsg;
     error() << Exception << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() ) ;
   } catch ( const std::exception& Exception ) {
     fatal() << " Standard std::exception is caught " << endmsg;
     error() << Exception.what() << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" ) ;
   } catch ( ... ) {
     fatal() << "UNKNOWN Exception is caught " << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
   return StatusCode::FAILURE;
 }

◆ sysRestart()

StatusCode Service::sysRestart ( )

override

Re-initialize the Service.

Definition at line 262 of file Service.cpp.

                                {
  
   StatusCode sc;
  
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::RUNNING != FSMState() ) {
     error() << "sysRestart(): cannot restart service in state " << FSMState() << " -- must be RUNNING " << endmsg;
     return StatusCode::FAILURE;
   }
  
   try {
  
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        ( m_auditorRestart ) ? auditorSvc().get() : nullptr, IAuditor::ReStart );
     sc = restart();
     return sc;
   } catch ( const GaudiException& Exception ) {
     fatal() << " Exception with tag=" << Exception.tag() << " is caught " << endmsg;
     error() << Exception << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() ) ;
   } catch ( const std::exception& Exception ) {
     fatal() << " Standard std::exception is caught " << endmsg;
     error() << Exception.what() << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" ) ;
   } catch ( ... ) {
     fatal() << "UNKNOWN Exception is caught " << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
   return StatusCode::FAILURE;
 }

◆ sysStart()

StatusCode Service::sysStart ( )

override

Initialize Service

Definition at line 125 of file Service.cpp.

                              {
   StatusCode sc;
  
   try {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::START, m_state );
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        ( m_auditorStart ) ? auditorSvc().get() : nullptr, IAuditor::Start );
     sc = start();
     if ( sc.isSuccess() ) m_state = m_targetState;
     return sc;
   } catch ( const GaudiException& Exception ) {
     fatal() << "in sysStart(): exception with tag=" << Exception.tag() << " is caught" << endmsg;
     error() << Exception << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() );
   } catch ( const std::exception& Exception ) {
     fatal() << "in sysStart(): standard std::exception is caught" << endmsg;
     fatal() << Exception.what() << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" );
   } catch ( ... ) {
     fatal() << "in sysStart(): UNKNOWN Exception is caught" << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
  
   return StatusCode::FAILURE;
 }

◆ sysStop()

StatusCode Service::sysStop ( )

override

Initialize Service

Definition at line 153 of file Service.cpp.

                             {
   StatusCode sc;
  
   try {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::STOP, m_state );
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        ( m_auditorStop ) ? auditorSvc().get() : nullptr, IAuditor::Stop );
     sc = stop();
     if ( sc.isSuccess() ) m_state = m_targetState;
     return sc;
   } catch ( const GaudiException& Exception ) {
     fatal() << "in sysStop(): exception with tag=" << Exception.tag() << " is caught" << endmsg;
     error() << Exception << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() );
   } catch ( const std::exception& Exception ) {
     fatal() << "in sysStop(): standard std::exception is caught" << endmsg;
     error() << Exception.what() << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" );
   } catch ( ... ) {
     fatal() << "in sysStop(): UNKNOWN Exception is caught" << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
  
   return StatusCode::FAILURE;
 }

◆ targetFSMState()

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

inlineoverride

Definition at line 63 of file Service.h.

63 { return m_targetState; }

◆ terminate()

StatusCode Service::terminate ( )

inlineoverride

Definition at line 61 of file Service.h.

61 { return StatusCode::SUCCESS; }

◆ tools() [1/2]

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

protected

Definition at line 415 of file Service.cpp.

                                      {
   if ( !m_toolHandlesInit ) initToolHandles();
  
   return m_tools;
 }

◆ tools() [2/2]

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

Definition at line 409 of file Service.cpp.

                                                  {
   if ( !m_toolHandlesInit ) initToolHandles();
  
   return m_tools;
 }

Friends And Related Function Documentation

◆ ServiceManager

friend class ServiceManager

friend

Definition at line 50 of file Service.h.

Member Data Documentation

◆ m_auditInit

Gaudi::Property<bool> Service::m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

protected

Definition at line 233 of file Service.h.

◆ m_auditorFinalize

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

protected

Definition at line 237 of file Service.h.

◆ m_auditorInitialize

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

protected

Definition at line 234 of file Service.h.

◆ m_auditorReinitialize

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

protected

Definition at line 238 of file Service.h.

◆ m_auditorRestart

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

protected

Definition at line 239 of file Service.h.

◆ m_auditorStart

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

protected

Definition at line 235 of file Service.h.

◆ m_auditorStop

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

protected

Definition at line 236 of file Service.h.

◆ m_autoRetrieveTools

Gaudi::Property<bool> Service::m_autoRetrieveTools

protected

Initial value:

{ this, "AutoRetrieveTools", true,

"retrieve all AlgTools during initialize" }

Definition at line 241 of file Service.h.

◆ m_checkToolDeps

Gaudi::Property<bool> Service::m_checkToolDeps

protected

Initial value:

{ this, "CheckToolDeps", true,

"check data dependencies of AlgTools (error if any found)" }

Definition at line 243 of file Service.h.

◆ m_initFlag

std::once_flag Service::m_initFlag

private

Definition at line 213 of file Service.h.

◆ m_initSC

StatusCode Service::m_initSC

private

Definition at line 212 of file Service.h.

◆ m_name

std::string Service::m_name

private

Service Name

Definition at line 216 of file Service.h.

◆ m_outputLevel

Gaudi::Property<int> Service::m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }

protected

flag indicating whether ToolHandle tools have been added to m_tools

Definition at line 232 of file Service.h.

◆ m_pAuditorSvc

SmartIF<IAuditorSvc> Service::m_pAuditorSvc

mutableprotected

Auditor Service

Definition at line 247 of file Service.h.

◆ m_state

Gaudi::StateMachine::State Service::m_state = Gaudi::StateMachine::OFFLINE

protected

Service state

Definition at line 203 of file Service.h.

◆ m_svcLocator

SmartIF<ISvcLocator> Service::m_svcLocator

mutableprivate

Service Locator reference

Definition at line 218 of file Service.h.

◆ m_svcManager

SmartIF<ISvcManager> Service::m_svcManager

private

Definition at line 219 of file Service.h.

◆ m_targetState

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

protected

Service state

Definition at line 205 of file Service.h.

◆ m_toolHandleArrays

std::vector<GaudiHandleArrayBase*> Service::m_toolHandleArrays

mutableprivate

Definition at line 226 of file Service.h.

◆ m_toolHandles

std::vector<BaseToolHandle*> Service::m_toolHandles

mutableprivate

Definition at line 225 of file Service.h.

◆ m_toolHandlesInit

bool Service::m_toolHandlesInit = false

mutableprivate

Definition at line 227 of file Service.h.

◆ m_tools

std::vector<IAlgTool*> Service::m_tools

mutableprivate

Definition at line 224 of file Service.h.

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

GaudiKernel/include/GaudiKernel/Service.h
GaudiKernel/src/Lib/Service.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Factory

Constructor & Destructor Documentation

◆ Service()

◆ ~Service()

Member Function Documentation

◆ addToolsArray()

◆ auditorSvc()

◆ configure()

◆ declareProperty() [1/2]

◆ declareProperty() [2/2]

◆ declareTool() [1/2]

◆ declareTool() [2/2]

◆ finalize()

◆ FSMState()

◆ initialize()

◆ initToolHandles()

◆ name()

◆ outputLevel()

◆ reinitialize()

◆ restart()

◆ service() [1/4]

◆ service() [2/4]

◆ service() [3/4]

◆ service() [4/4]

◆ serviceLocator()

◆ setServiceManager()

◆ start()

◆ stop()

◆ sysFinalize()

◆ sysInitialize()

◆ sysInitialize_imp()

◆ sysReinitialize()

◆ sysRestart()

◆ sysStart()

◆ sysStop()

◆ targetFSMState()

◆ terminate()

◆ tools() [1/2]

◆ tools() [2/2]

Friends And Related Function Documentation

◆ ServiceManager

Member Data Documentation

◆ m_auditInit

◆ m_auditorFinalize

◆ m_auditorInitialize

◆ m_auditorReinitialize

◆ m_auditorRestart

◆ m_auditorStart

◆ m_auditorStop

◆ m_autoRetrieveTools

◆ m_checkToolDeps

◆ m_initFlag

◆ m_initSC

◆ m_name

◆ m_outputLevel

◆ m_pAuditorSvc

◆ m_state

◆ m_svcLocator

◆ m_svcManager

◆ m_targetState

◆ m_toolHandleArrays

◆ m_toolHandles

◆ m_toolHandlesInit

◆ m_tools