Base class from which all the concrete tool classes should be derived. More...

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for AlgTool:

[legend]

Collaboration diagram for AlgTool:

[legend]

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

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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 PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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...

Public Member Functions
StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown) override
	Query for a given interface. More...

const std::string &	name () const override
	Retrieve full identifying name of the concrete tool object. More...

const std::string &	type () const override
	Retrieve type (concrete class) of the sub-algtool. More...

const IInterface *	parent () const override
	Retrieve parent of the sub-algtool. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

StatusCode	reinitialize () override

StatusCode	restart () override

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

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

StatusCode	sysInitialize () override
	Initialize AlgTool. More...

StatusCode	sysStart () override
	Start AlgTool. More...

StatusCode	sysStop () override
	Stop AlgTool. More...

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

StatusCode	sysReinitialize () override
	Initialize AlgTool. More...

StatusCode	sysRestart () override
	Start AlgTool. More...

	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...

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

ISvcLocator *	svcLoc () const
	shortcut for the method service locator More...

IDataProviderSvc *	evtSvc () const
	accessor to event service service More...

IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...

template<class T >
StatusCode	service (const std::string &name, T *&svc, 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 &type, const std::string &name, T *&svc) const
	Access a service by name, type creating it if it doesn't already exist. More...

SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...

template<typename T >
SmartIF< T >	service (const std::string &name, const bool createIf=true, const bool quiet=false) 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, std::string toolTypeAndName, bool createIf=true)

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)

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

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

IAuditorSvc *	auditorSvc () const
	Access the auditor service. More...

IMonitorSvc *	monitorSvc () const
	Access the monitor service. More...

template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...

	~AlgTool () override

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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 Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

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

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

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

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

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

StatusCode	getProperty (const std::string &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 (const std::string &name) const override
	Return true if we have a property with the given name. More...

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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...

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

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

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

Protected Member Functions
template<typename I >
void	declareInterface (I *i)

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

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this More...

Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, 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
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles. More...

Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

Private Types
typedef std::list< std::pair< InterfaceID, void * > >	InterfaceList

Private Member Functions
void	initToolHandles () const

StatusCode	service_i (const std::string &algName, bool createIf, const InterfaceID &iid, void **ppSvc) const
	flag indicating whether ToolHandle tools have been added to m_tools More...

StatusCode	service_i (const std::string &svcType, const std::string &svcName, const InterfaceID &iid, void **ppS) const

Private Attributes
std::string	m_type
	AlgTool type (concrete class name) More...

const std::string	m_name
	AlgTool full name. More...

const IInterface *	m_parent = nullptr
	AlgTool parent. More...

SmartIF< ISvcLocator >	m_svcLocator
	Pointer to Service Locator service. More...

SmartIF< IDataProviderSvc >	m_evtSvc
	Event data service. More...

SmartIF< IToolSvc >	m_ptoolSvc
	Tool service. More...

SmartIF< IMonitorSvc >	m_pMonitorSvc
	Online Monitoring Service. More...

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

InterfaceList	m_interfaceList
	Interface list. More...

Gaudi::Property< int >	m_outputLevel

Gaudi::Property< std::string >	m_monitorSvcName

Gaudi::Property< bool >	m_auditInit {this, "AuditTools", false, " 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()"}

std::vector< IAlgTool * >	m_tools

std::vector< BaseToolHandle * >	m_toolHandles

std::vector< GaudiHandleArrayBase * >	m_toolHandleArrays

bool	m_toolHandlesInit = false

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::CONFIGURED
	state of the Tool More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::CONFIGURED
	state of the Tool More...

Detailed Description

Base class from which all the concrete tool classes should be derived.

Specific methods for doing something useful should be implemented in the concrete tools. Sub-types of this class could implement an additional interface for behavior common to sets of concrete tools (for example vertexers).

Author: Gloria Corti; Pere Mato

Definition at line 47 of file AlgTool.h.

Member Typedef Documentation

◆ Factory

using AlgTool::Factory = Gaudi::PluginService::Factory<IAlgTool*( const std::string&, const std::string&, const IInterface* )>

Definition at line 51 of file AlgTool.h.

◆ InterfaceList

typedef std::list<std::pair<InterfaceID, void*> > AlgTool::InterfaceList

private

Definition at line 276 of file AlgTool.h.

Constructor & Destructor Documentation

◆ AlgTool()

AlgTool::AlgTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard Constructor.

Parameters

type	the concrete class of the sub-algtool
name	the full name of the concrete sub-algtool
parent	the parent of the concrete sub-algtool

Definition at line 118 of file AlgTool.cpp.

     : m_type( type ), m_name( name ), m_parent( parent ) {
   addRef(); // Initial count set to 1
 
   IInterface* _p = const_cast<IInterface*>( parent );
 
   if ( Gaudi::Algorithm* _alg = dynamic_cast<Gaudi::Algorithm*>( _p ) ) {
     m_svcLocator = _alg->serviceLocator();
   } else if ( Service* _svc = dynamic_cast<Service*>( _p ) ) {
     m_svcLocator = _svc->serviceLocator();
   } else if ( AlgTool* _too = dynamic_cast<AlgTool*>( _p ) ) {
     m_svcLocator = _too->serviceLocator();
   } else if ( Auditor* _aud = dynamic_cast<Auditor*>( _p ) ) {
     m_svcLocator = _aud->serviceLocator();
   } else {
     throw GaudiException( "Failure to create tool '" + type + "/" + name + "': illegal parent type '" +
                               System::typeinfoName( typeid( *_p ) ) + "'",
                           "AlgTool", StatusCode::FAILURE );
   }
 
   // inherit output level from parent
   { // get the "OutputLevel" property from parent
     SmartIF<IProperty> pprop( _p );
     if ( pprop && pprop->hasProperty( "OutputLevel" ) ) { m_outputLevel.assign( pprop->getProperty( "OutputLevel" ) ); }
   }
 
   {
     // Auditor monitoring properties
     // Initialize the default value from ApplicationMgr AuditAlgorithms
     Gaudi::Property<bool> audit( false );
     // note that here we need that the service locator is already defined
     auto appMgr = serviceLocator()->service<IProperty>( "ApplicationMgr" );
     if ( appMgr && appMgr->hasProperty( "AuditTools" ) ) { audit.assign( appMgr->getProperty( "AuditTools" ) ); }
     m_auditInit           = audit;
     m_auditorInitialize   = audit;
     m_auditorStart        = audit;
     m_auditorStop         = audit;
     m_auditorFinalize     = audit;
     m_auditorReinitialize = audit;
     m_auditorRestart      = audit;
   }
 }

◆ ~AlgTool()

AlgTool::~AlgTool ( )

override

Definition at line 354 of file AlgTool.cpp.

 {
   if ( m_pMonitorSvc ) { m_pMonitorSvc->undeclareAll( this ); }
 }

Member Function Documentation

◆ acceptDHVisitor()

void AlgTool::acceptDHVisitor ( IDataHandleVisitor * vis ) const

override

Definition at line 443 of file AlgTool.cpp.

                                                              {
   //-----------------------------------------------------------------------------
   vis->visit( this );
 
   for ( auto tool : tools() ) vis->visit( dynamic_cast<AlgTool*>( tool ) );
 }

◆ addToolsArray()

template<class T >

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

inline

Definition at line 193 of file AlgTool.h.

                                                     {
     m_toolHandleArrays.push_back( &hndlArr );
   }

◆ auditorSvc()

IAuditorSvc * AlgTool::auditorSvc ( ) const

Access the auditor service.

Definition at line 433 of file AlgTool.cpp.

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

◆ configure()

StatusCode AlgTool::configure ( )

inlineoverride

Definition at line 66 of file AlgTool.h.

66 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:85

◆ declareInfo() [1/2]

template<class T >

void AlgTool::declareInfo	(	const std::string &	name,
		const T &	var,
		const std::string &	desc
	)		const

inline

Declare monitoring information.

Parameters

name	Monitoring information name known to the external system
var	Monitoring Listener address (the item to monitor...)
desc	Textual description of the information being monitored

Definition at line 254 of file AlgTool.h.

                                                                                        {
     IMonitorSvc* mS = monitorSvc();
     if ( mS ) mS->declareInfo( name, var, desc, this );
   }

◆ declareInfo() [2/2]

void AlgTool::declareInfo	(	const std::string &	name,
		const std::string &	format,
		const void *	var,
		int	size,
		const std::string &	desc
	)		const

inline

Declare monitoring information (special case)

Parameters

name	Monitoring information name known to the external system
format	Format information
var	Monitoring Listener address
size	Monitoring Listener address size
desc	Textual description of the information being monitored

Definition at line 266 of file AlgTool.h.

                                                   {
     IMonitorSvc* mS = monitorSvc();
     if ( mS ) mS->declareInfo( name, format, var, size, desc, this );
   }

◆ declareInterface()

template<typename I >

void AlgTool::declareInterface ( I * i )

inlineprotected

Definition at line 149 of file AlgTool.h.

                                 {
     m_interfaceList.emplace_back( I::interfaceID(), i );
   }

◆ declareProperty() [1/2]

template<class T >

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

inline

Definition at line 157 of file AlgTool.h.

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

◆ declareProperty() [2/2]

template<class T >

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

inline

Definition at line 186 of file AlgTool.h.

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

◆ declareTool() [1/2]

template<class T >

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

inline

Definition at line 164 of file AlgTool.h.

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

◆ declareTool() [2/2]

template<class T >

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

inline

Definition at line 169 of file AlgTool.h.

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

◆ deregisterTool()

void AlgTool::deregisterTool ( IAlgTool * tool ) const

inline

Definition at line 206 of file AlgTool.h.

                                               {
     auto it = std::find( m_tools.begin(), m_tools.end(), tool );
     if ( it != m_tools.end() ) {
       if ( UNLIKELY( msgLevel( MSG::DEBUG ) ) ) debug() << "De-Registering tool " << tool->name() << endmsg;
       m_tools.erase( it );
     } else {
       if ( UNLIKELY( msgLevel( MSG::DEBUG ) ) ) debug() << "Could not de-register tool " << tool->name() << endmsg;
     }
   }

◆ evtSvc()

IDataProviderSvc * AlgTool::evtSvc ( ) const

accessor to event service service

Returns: pointer to detector service

Definition at line 88 of file AlgTool.cpp.

                                         {
   if ( !m_evtSvc ) {
     m_evtSvc = service( "EventDataSvc", true );
     if ( !m_evtSvc ) { throw GaudiException( "Service [EventDataSvc] not found", name(), StatusCode::FAILURE ); }
   }
   return m_evtSvc.get();
 }

◆ finalize()

StatusCode AlgTool::finalize ( )

override

Definition at line 268 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

◆ FSMState()

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

inlineoverride

Definition at line 74 of file AlgTool.h.

74 { return m_state; }

AlgTool::m_state

Gaudi::StateMachine::State m_state

state of the Tool

Definition: AlgTool.h:319

◆ initialize()

StatusCode AlgTool::initialize ( )

override

Definition at line 201 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   // Setting the properties is done by the ToolSvc calling setProperties()
   // explicitly.
   return StatusCode::SUCCESS;
 }

◆ initToolHandles()

void AlgTool::initToolHandles ( ) const

private

Definition at line 360 of file AlgTool.cpp.

                                     {
   auto init_one = [&]( BaseToolHandle* th ) {
     if ( !th->isEnabled() ) {
       if ( UNLIKELY( msgLevel( MSG::DEBUG ) ) && !th->typeAndName().empty() )
         debug() << "ToolHandle " << th->typeAndName() << " not used" << endmsg;
       return;
     }
     if ( !th->get() ) {
       auto sc = th->retrieve();
       if ( UNLIKELY( sc.isFailure() ) ) {
         throw GaudiException( "Failed to retrieve tool " + th->typeAndName(), this->name(), StatusCode::FAILURE );
       }
     }
     auto* tool = th->get();
     if ( UNLIKELY( 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 ( UNLIKELY( 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;
 }

◆ monitorSvc()

IMonitorSvc* AlgTool::monitorSvc ( ) const

inline

Access the monitor service.

Attention: Note that this method will return a NULL pointer if no monitor service is configured to be present. You must take this possibility into account when using the pointer

Returns: Pointer to the Monitor service

Return values

NULL	No monitor service is present
non-NULL	A monitor service is present and available to be used

Definition at line 242 of file AlgTool.h.

                                          {
     // If not already located try to locate it without forcing a creation
     if ( !m_pMonitorSvc ) m_pMonitorSvc = service( m_monitorSvcName, false, true );
     return m_pMonitorSvc.get();
   }

◆ name()

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

override

Retrieve full identifying name of the concrete tool object.

Definition at line 58 of file AlgTool.cpp.

 {
   return m_name;
 }

◆ parent()

const IInterface * AlgTool::parent ( ) const

override

Retrieve parent of the sub-algtool.

Definition at line 72 of file AlgTool.cpp.

 {
   return m_parent;
 }

◆ queryInterface()

StatusCode AlgTool::queryInterface	(	const InterfaceID &	riid,
		void **	ppvUnknown
	)

override

Query for a given interface.

Definition at line 41 of file AlgTool.cpp.

 {
   if ( !ppvi ) { return StatusCode::FAILURE; } // RETURN
   StatusCode sc = base_class::queryInterface( riid, ppvi );
   if ( sc.isSuccess() ) return sc;
   auto i = std::find_if( std::begin( m_interfaceList ), std::end( m_interfaceList ),
                          [&]( const std::pair<InterfaceID, void*>& item ) { return item.first.versionMatch( riid ); } );
   if ( i == std::end( m_interfaceList ) ) {
     *ppvi = nullptr;
     return Status::NO_INTERFACE; // RETURN
   }
   *ppvi = i->second;
   addRef();
   return StatusCode::SUCCESS; // RETURN
 }

◆ registerTool()

void AlgTool::registerTool ( IAlgTool * tool ) const

inline

Definition at line 201 of file AlgTool.h.

                                             {
     if ( UNLIKELY( msgLevel( MSG::DEBUG ) ) ) debug() << "Registering tool " << tool->name() << endmsg;
     m_tools.push_back( tool );
   }

◆ reinitialize()

StatusCode AlgTool::reinitialize ( )

override

Definition at line 294 of file AlgTool.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 AlgTool::restart ( )

override

Definition at line 336 of file AlgTool.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<class T >

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

inline

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

Definition at line 128 of file AlgTool.h.

                                                                                    {
     return service_i( name, createIf, T::interfaceID(), (void**)&svc );
   }

◆ service() [2/4]

template<class T >

StatusCode AlgTool::service	(	const std::string &	type,
		const std::string &	name,
		T *&	svc
	)		const

inline

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

Definition at line 135 of file AlgTool.h.

                                                                                     {
     return service_i( type, name, T::interfaceID(), reinterpret_cast<void**>( &svc ) );
   }

◆ service() [3/4]

SmartIF< IService > AlgTool::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

Return a pointer to the service identified by name (or "type/name")

Definition at line 427 of file AlgTool.cpp.

                                                                                                        {
   const ServiceLocatorHelper helper( *serviceLocator(), *this );
   return helper.service( name, quiet, createIf );
 }

◆ service() [4/4]

template<typename T >

SmartIF<T> AlgTool::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

inline

Definition at line 143 of file AlgTool.h.

                                                                                                           {
     return SmartIF<T>( service( name, createIf, quiet ) );
   }

◆ service_i() [1/2]

StatusCode AlgTool::service_i	(	const std::string &	algName,
		bool	createIf,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

private

flag indicating whether ToolHandle tools have been added to m_tools

implementation of service method

Definition at line 415 of file AlgTool.cpp.

                                                                                                                    {
   const ServiceLocatorHelper helper( *serviceLocator(), *this );
   return helper.getService( svcName, createIf, iid, ppSvc );
 }

◆ service_i() [2/2]

StatusCode AlgTool::service_i	(	const std::string &	svcType,
		const std::string &	svcName,
		const InterfaceID &	iid,
		void **	ppS
	)		const

private

Definition at line 421 of file AlgTool.cpp.

                                                     {
   const ServiceLocatorHelper helper( *serviceLocator(), *this );
   return helper.createService( svcType, svcName, iid, ppSvc );
 }

◆ serviceLocator()

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

override

Retrieve pointer to service locator.

Definition at line 79 of file AlgTool.cpp.

 {
   return m_svcLocator;
 }

◆ setProperties()

StatusCode AlgTool::setProperties ( )

Method for setting declared properties to the values specified in the jobOptions via the job option service.

This method is called by the ToolSvc after creating the concrete tool, before passing it to the requesting parent and does not need to be called explicitly.

Definition at line 107 of file AlgTool.cpp.

 {
   if ( !m_svcLocator ) return StatusCode::FAILURE;
   auto jos = m_svcLocator->service<IJobOptionsSvc>( "JobOptionsSvc" );
   if ( !jos ) return StatusCode::FAILURE;
 
   return jos->setMyProperties( name(), this );
 }

◆ start()

StatusCode AlgTool::start ( )

override

Definition at line 225 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

◆ stop()

StatusCode AlgTool::stop ( )

override

Definition at line 247 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

◆ svcLoc()

ISvcLocator* AlgTool::svcLoc ( ) const

inline

shortcut for the method service locator

Definition at line 107 of file AlgTool.h.

107 { return serviceLocator(); }

AlgTool::serviceLocator

SmartIF< ISvcLocator > & serviceLocator() const override

Retrieve pointer to service locator.

Definition: AlgTool.cpp:79

◆ sysFinalize()

StatusCode AlgTool::sysFinalize ( )

override

Finalize AlgTool.

Definition at line 255 of file AlgTool.cpp.

                                 {
   //-----------------------------------------------------------------------------
   return attempt( *this, "sysFinalize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::FINALIZE, m_state );
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        m_auditorFinalize ? auditorSvc() : nullptr, IAuditor::Finalize );
     StatusCode                  sc = finalize();
     if ( sc.isSuccess() ) m_state = m_targetState;
     return sc;
   } );
 }

◆ sysInitialize()

StatusCode AlgTool::sysInitialize ( )

override

Initialize AlgTool.

Definition at line 163 of file AlgTool.cpp.

                                   {
   //-----------------------------------------------------------------------------
   return attempt( *this, "sysInitialize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::INITIALIZE, m_state );
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        m_auditorInitialize ? auditorSvc() : nullptr, IAuditor::Initialize );
     StatusCode                  sc = initialize();
     if ( !sc ) return sc;
 
     m_state = m_targetState;
     if ( m_updateDataHandles ) acceptDHVisitor( m_updateDataHandles.get() );
 
     // check for explicit circular data dependencies in declared handles
     DataObjIDColl out;
     for ( auto& h : outputHandles() ) {
       if ( !h->objKey().empty() ) out.emplace( h->fullKey() );
     }
     for ( auto& h : inputHandles() ) {
       if ( !h->objKey().empty() && out.find( h->fullKey() ) != out.end() ) {
         error() << "Explicit circular data dependency found for id " << h->fullKey() << endmsg;
         sc = StatusCode::FAILURE;
       }
     }
 
     if ( !sc ) return sc;
 
     // visit all sub-tools, build full set
     DHHVisitor avis( m_inputDataObjs, m_outputDataObjs );
     acceptDHVisitor( &avis );
 
     // initialize handles
     initDataHandleHolder(); // this should 'freeze' the handle configuration.
 
     return sc;
   } );
 }

◆ sysReinitialize()

StatusCode AlgTool::sysReinitialize ( )

override

Initialize AlgTool.

Definition at line 276 of file AlgTool.cpp.

                                     {
   //-----------------------------------------------------------------------------
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::INITIALIZED != FSMState() ) {
     error() << "sysReinitialize(): cannot reinitialize tool not initialized" << endmsg;
     return StatusCode::FAILURE;
   }
 
   return attempt( *this, "SysReinitialize()", [&]() {
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        m_auditorReinitialize ? auditorSvc() : nullptr, IAuditor::ReInitialize );
     return reinitialize();
   } );
 }

◆ sysRestart()

StatusCode AlgTool::sysRestart ( )

override

Start AlgTool.

Definition at line 317 of file AlgTool.cpp.

                                {
   //-----------------------------------------------------------------------------
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::RUNNING != FSMState() ) {
     error() << "sysRestart(): cannot reinitialize tool not started" << endmsg;
     return StatusCode::FAILURE;
   }
 
   return attempt( *this, "sysRestart", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::START, m_state );
     Gaudi::Guards::AuditorGuard guard( this,
                                        // check if we want to audit the initialize
                                        m_auditorRestart ? auditorSvc() : nullptr, IAuditor::ReStart );
     return restart();
   } );
 }

◆ sysStart()

StatusCode AlgTool::sysStart ( )

override

Start AlgTool.

Definition at line 211 of file AlgTool.cpp.

                              {
   //-----------------------------------------------------------------------------
   return attempt( *this, "sysStart", [&]() {
     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() : nullptr, IAuditor::Start );
     StatusCode                  sc = start();
     if ( sc.isSuccess() ) m_state = m_targetState;
     return sc;
   } );
 }

◆ sysStop()

StatusCode AlgTool::sysStop ( )

override

Stop AlgTool.

Definition at line 233 of file AlgTool.cpp.

                             {
   //-----------------------------------------------------------------------------
   return attempt( *this, "sysStop", [&]() {
     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() : nullptr, IAuditor::Stop );
     StatusCode                  sc = stop();
     if ( sc.isSuccess() ) m_state = m_targetState;
     return sc;
   } );
 }

◆ targetFSMState()

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

inlineoverride

Definition at line 75 of file AlgTool.h.

75 { return m_targetState; }

AlgTool::m_targetState

Gaudi::StateMachine::State m_targetState

state of the Tool

Definition: AlgTool.h:320

◆ terminate()

StatusCode AlgTool::terminate ( )

inlineoverride

Definition at line 71 of file AlgTool.h.

71 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:85

◆ tools() [1/2]

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

Definition at line 401 of file AlgTool.cpp.

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

◆ tools() [2/2]

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

protected

Definition at line 407 of file AlgTool.cpp.

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

◆ toolSvc()

IToolSvc * AlgTool::toolSvc ( ) const

The standard ToolSvc service, Return a pointer to the service if present.

Definition at line 96 of file AlgTool.cpp.

 {
   if ( !m_ptoolSvc ) {
     m_ptoolSvc = service( "ToolSvc", true );
     if ( !m_ptoolSvc ) { throw GaudiException( "Service [ToolSvc] not found", name(), StatusCode::FAILURE ); }
   }
   return m_ptoolSvc.get();
 }

◆ type()

const std::string & AlgTool::type ( ) const

override

Retrieve type (concrete class) of the sub-algtool.

Definition at line 65 of file AlgTool.cpp.

 {
   return m_type;
 }

Member Data Documentation

◆ m_auditInit

Gaudi::Property<bool> AlgTool::m_auditInit {this, "AuditTools", false, " unused"}

private

Definition at line 300 of file AlgTool.h.

◆ m_auditorFinalize

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

private

Definition at line 304 of file AlgTool.h.

◆ m_auditorInitialize

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

private

Definition at line 301 of file AlgTool.h.

◆ m_auditorReinitialize

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

private

Definition at line 305 of file AlgTool.h.

◆ m_auditorRestart

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

private

Definition at line 306 of file AlgTool.h.

◆ m_auditorStart

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

private

Definition at line 302 of file AlgTool.h.

◆ m_auditorStop

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

private

Definition at line 303 of file AlgTool.h.

◆ m_evtSvc

SmartIF<IDataProviderSvc> AlgTool::m_evtSvc

mutableprivate

Event data service.

Definition at line 283 of file AlgTool.h.

◆ m_interfaceList

InterfaceList AlgTool::m_interfaceList

private

Interface list.

Definition at line 288 of file AlgTool.h.

◆ m_monitorSvcName

Gaudi::Property<std::string> AlgTool::m_monitorSvcName

private

Initial value:

{this, "MonitorService", "MonitorSvc",

"name to use for Monitor Service"}

Definition at line 297 of file AlgTool.h.

◆ m_name

const std::string AlgTool::m_name

private

AlgTool full name.

Definition at line 279 of file AlgTool.h.

◆ m_outputLevel

Gaudi::Property<int> AlgTool::m_outputLevel

private

Initial value:

{
      this, "OutputLevel", setUpMessaging(),
      [this]( Gaudi::Details::PropertyBase& ) { this->updateMsgStreamOutputLevel( this->m_outputLevel ); },
      "output level"}

Definition at line 292 of file AlgTool.h.

◆ m_parent

const IInterface* AlgTool::m_parent = nullptr

private

AlgTool parent.

Definition at line 280 of file AlgTool.h.

◆ m_pAuditorSvc

SmartIF<IAuditorSvc> AlgTool::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 286 of file AlgTool.h.

◆ m_pMonitorSvc

SmartIF<IMonitorSvc> AlgTool::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 285 of file AlgTool.h.

◆ m_ptoolSvc

SmartIF<IToolSvc> AlgTool::m_ptoolSvc

mutableprivate

Tool service.

Definition at line 284 of file AlgTool.h.

◆ m_state

Gaudi::StateMachine::State AlgTool::m_state = Gaudi::StateMachine::CONFIGURED

private

state of the Tool

Definition at line 319 of file AlgTool.h.

◆ m_svcLocator

SmartIF<ISvcLocator> AlgTool::m_svcLocator

mutableprivate

Pointer to Service Locator service.

Definition at line 282 of file AlgTool.h.

◆ m_targetState

Gaudi::StateMachine::State AlgTool::m_targetState = Gaudi::StateMachine::CONFIGURED

private

state of the Tool

Definition at line 320 of file AlgTool.h.

◆ m_toolHandleArrays

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

mutableprivate

Definition at line 311 of file AlgTool.h.

◆ m_toolHandles

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

mutableprivate

Definition at line 310 of file AlgTool.h.

◆ m_toolHandlesInit

bool AlgTool::m_toolHandlesInit = false

mutableprivate

Definition at line 312 of file AlgTool.h.

◆ m_tools

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

mutableprivate

Definition at line 309 of file AlgTool.h.

◆ m_type

std::string AlgTool::m_type

private

AlgTool type (concrete class name)

Definition at line 278 of file AlgTool.h.

◆ m_updateDataHandles

std::unique_ptr<IDataHandleVisitor> AlgTool::m_updateDataHandles

protected

Hook for for derived classes to provide a custom visitor for data handles.

Definition at line 222 of file AlgTool.h.

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

GaudiKernel/GaudiKernel/AlgTool.h
GaudiKernel/src/Lib/AlgTool.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Factory

◆ InterfaceList

Constructor & Destructor Documentation

◆ AlgTool()

◆ ~AlgTool()

Member Function Documentation

◆ acceptDHVisitor()

◆ addToolsArray()

◆ auditorSvc()

◆ configure()

◆ declareInfo() [1/2]

◆ declareInfo() [2/2]

◆ declareInterface()

◆ declareProperty() [1/2]

◆ declareProperty() [2/2]

◆ declareTool() [1/2]

◆ declareTool() [2/2]

◆ deregisterTool()

◆ evtSvc()

◆ finalize()

◆ FSMState()

◆ initialize()

◆ initToolHandles()

◆ monitorSvc()

◆ name()

◆ parent()

◆ queryInterface()

◆ registerTool()

◆ reinitialize()

◆ restart()

◆ service() [1/4]

◆ service() [2/4]

◆ service() [3/4]

◆ service() [4/4]

◆ service_i() [1/2]

◆ service_i() [2/2]

◆ serviceLocator()

◆ setProperties()

◆ start()

◆ stop()

◆ svcLoc()

◆ sysFinalize()

◆ sysInitialize()

◆ sysReinitialize()

◆ sysRestart()

◆ sysStart()

◆ sysStop()

◆ targetFSMState()

◆ terminate()

◆ tools() [1/2]

◆ tools() [2/2]

◆ toolSvc()

◆ type()

Member Data Documentation

◆ m_auditInit

◆ m_auditorFinalize

◆ m_auditorInitialize

◆ m_auditorReinitialize

◆ m_auditorRestart

◆ m_auditorStart

◆ m_auditorStop

◆ m_evtSvc

◆ m_interfaceList

◆ m_monitorSvcName

◆ m_name

◆ m_outputLevel

◆ m_parent

◆ m_pAuditorSvc

◆ m_pMonitorSvc

◆ m_ptoolSvc

◆ m_state