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
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

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

Public Types inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

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

void const *	i_cast (const InterfaceID &riid) const override

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

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

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

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.

StatusCode	sysStart () override
	Start AlgTool.

StatusCode	sysStop () override
	Stop AlgTool.

StatusCode	sysFinalize () override
	Finalize AlgTool.

StatusCode	sysReinitialize () override
	Initialize AlgTool.

StatusCode	sysRestart () override
	Start AlgTool.

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

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

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

IDataProviderSvc *	evtSvc () const
	accessor to event service service

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

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

template<typename T>
SmartIF< T >	service (std::string_view 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, const 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.

IMonitorSvc *	monitorSvc () const
	Access the monitor service.

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

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)

	~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

bool	renounceInput (const DataObjID &id) 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 const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

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

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

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

	PropertyHolder ()=default

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

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	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)

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

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

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

Protected Attributes
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles.

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

Private Attributes
friend	ToolSvc

std::string	m_type
	AlgTool type (concrete class name)

const std::string	m_name
	AlgTool full name.

const IInterface *	m_parent = nullptr
	AlgTool parent.

SmartIF< ISvcLocator >	m_svcLocator
	Pointer to Service Locator service.

SmartIF< IDataProviderSvc >	m_evtSvc
	Event data service.

SmartIF< IToolSvc >	m_ptoolSvc
	Tool service.

SmartIF< IMonitorSvc >	m_pMonitorSvc
	Online Monitoring Service.

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

InterfaceList	m_interfaceList
	Interface list.

Gaudi::Property< int >	m_outputLevel

Gaudi::Property< std::string >	m_monitorSvcName

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
	flag indicating whether ToolHandle tools have been added to m_tools

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

Friends
class	ToolVisitor

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 53 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 60 of file AlgTool.h.

◆ InterfaceList

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

private

Definition at line 262 of file AlgTool.h.

Constructor & Destructor Documentation

◆ AlgTool()

AlgTool::AlgTool	(	std::string	type,
		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 95 of file AlgTool.cpp.

    : m_type( std::move( type ) ), m_name( std::move( 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 ( Gaudi::Auditor* _aud = dynamic_cast<Gaudi::Auditor*>( _p ) ) {
    m_svcLocator = _aud->serviceLocator();
  } else {
    throw GaudiException( "Failure to create tool '" + m_type + "/" + m_name + "': illegal parent type '" +
                              System::typeinfoName( typeid( *_p ) ) + "'",
                          "AlgTool", StatusCode::FAILURE );
  }
 
  // inherit output level from parent
  // get the "OutputLevel" property from parent
  if ( SmartIF<IProperty> pprop( _p ); pprop && pprop->hasProperty( "OutputLevel" ) ) {
    m_outputLevel.assign( pprop->getProperty( "OutputLevel" ) );
  }
 
  // Auditor monitoring properties
  // Initialize the default value from ApplicationMgr AuditAlgorithms
  Gaudi::Property<bool> audit( "AuditTools", false );
  // note that here we need that the service locator is already defined
  if ( auto appMgr = serviceLocator()->service<IProperty>( "ApplicationMgr" ) ) {
    appMgr->getProperty( &audit ).ignore();
  }
 
  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 298 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 368 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 180 of file AlgTool.h.

                                                    {
    m_toolHandleArrays.push_back( &hndlArr );
  }

◆ auditorSvc()

IAuditorSvc * AlgTool::auditorSvc ( ) const

Access the auditor service.

Definition at line 360 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 76 of file AlgTool.h.

76{ return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition StatusCode.h:99

◆ declareInfo() [1/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 252 of file AlgTool.h.

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

◆ declareInfo() [2/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 240 of file AlgTool.h.

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

◆ declareInterface()

template<typename I>

void AlgTool::declareInterface ( I * i )

inlineprotected

Definition at line 137 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 145 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 173 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 152 of file AlgTool.h.

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

◆ declareTool() [2/2]

template<class T>

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

inline

Definition at line 157 of file AlgTool.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;
  }

◆ deregisterTool()

void AlgTool::deregisterTool ( IAlgTool * tool ) const

inline

Definition at line 193 of file AlgTool.h.

                                              {
    auto it = std::find( m_tools.begin(), m_tools.end(), tool );
    if ( it != m_tools.end() ) {
      if ( msgLevel( MSG::DEBUG ) ) debug() << "De-Registering tool " << tool->name() << endmsg;
      m_tools.erase( it );
    } else {
      if ( 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 80 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 225 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 84 of file AlgTool.h.

84{ return m_state; }

AlgTool::m_state

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition AlgTool.h:299

◆ i_cast()

void const * AlgTool::i_cast ( const InterfaceID & riid ) const

override

Definition at line 61 of file AlgTool.cpp.

                                                           {
  if ( auto output = base_class::i_cast( riid ) ) { return output; }
  if ( auto i =
           std::find_if( std::begin( m_interfaceList ), std::end( m_interfaceList ),
                         [&]( const std::pair<InterfaceID, void*>& item ) { return item.first.versionMatch( riid ); } );
       i != std::end( m_interfaceList ) ) {
    return i->second;
  }
  return nullptr;
}

◆ initialize()

StatusCode AlgTool::initialize ( )

override

Definition at line 173 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 302 of file AlgTool.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;
}

◆ 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 228 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 72 of file AlgTool.cpp.

72{ return m_name; }

◆ parent()

const IInterface * AlgTool::parent ( ) const

override

Retrieve parent of the sub-algtool.

Definition at line 76 of file AlgTool.cpp.

76{ return m_parent; }

◆ queryInterface()

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

override

Query for a given interface.

Definition at line 46 of file AlgTool.cpp.

                                                                         {
  if ( !ppvi ) { return StatusCode::FAILURE; }
  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;
  }
  *ppvi = i->second;
  addRef();
  return StatusCode::SUCCESS;
}

◆ registerTool()

void AlgTool::registerTool ( IAlgTool * tool ) const

inline

Definition at line 188 of file AlgTool.h.

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

◆ reinitialize()

StatusCode AlgTool::reinitialize ( )

override

Definition at line 246 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 283 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/2]

SmartIF< IService > AlgTool::service	(	std::string_view	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 355 of file AlgTool.cpp.

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

◆ service() [2/2]

template<typename T>

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

inline

Definition at line 131 of file AlgTool.h.

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

◆ serviceLocator()

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

override

Retrieve pointer to service locator.

Definition at line 78 of file AlgTool.cpp.

78{ return m_svcLocator; }

◆ start()

StatusCode AlgTool::start ( )

override

Definition at line 192 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 209 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 117 of file AlgTool.h.

117{ return serviceLocator(); }

◆ sysFinalize()

StatusCode AlgTool::sysFinalize ( )

override

Finalize AlgTool.

Definition at line 214 of file AlgTool.cpp.

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

◆ sysInitialize()

StatusCode AlgTool::sysInitialize ( )

override

Initialize AlgTool.

Definition at line 137 of file AlgTool.cpp.

                                  {
  return attempt( *this, "sysInitialize", [&]() {
    m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::INITIALIZE, m_state );
    Gaudi::Guards::AuditorGuard guard( name(),
                                       // check if we want to audit the initialize
                                       m_auditorInitialize ? auditorSvc() : nullptr, Gaudi::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 230 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( name(),
                                       // check if we want to audit the initialize
                                       m_auditorReinitialize ? auditorSvc() : nullptr, Gaudi::IAuditor::ReInitialize );
    return reinitialize();
  } );
}

◆ sysRestart()

StatusCode AlgTool::sysRestart ( )

override

Start AlgTool.

Definition at line 266 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( name(),
                                       // check if we want to audit the initialize
                                       m_auditorRestart ? auditorSvc() : nullptr, Gaudi::IAuditor::ReStart );
    return restart();
  } );
}

◆ sysStart()

StatusCode AlgTool::sysStart ( )

override

Start AlgTool.

Definition at line 180 of file AlgTool.cpp.

                             {
  return attempt( *this, "sysStart", [&]() {
    m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::START, m_state );
    Gaudi::Guards::AuditorGuard guard( name(),
                                       // check if we want to audit the initialize
                                       m_auditorStart ? auditorSvc() : nullptr, Gaudi::IAuditor::Start );
    StatusCode                  sc = start();
    if ( sc.isSuccess() ) m_state = m_targetState;
    return sc;
  } );
}

◆ sysStop()

StatusCode AlgTool::sysStop ( )

override

Stop AlgTool.

Definition at line 197 of file AlgTool.cpp.

                            {
  return attempt( *this, "sysStop", [&]() {
    m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::STOP, m_state );
    Gaudi::Guards::AuditorGuard guard( name(),
                                       // check if we want to audit the initialize
                                       m_auditorStop ? auditorSvc() : nullptr, Gaudi::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 85 of file AlgTool.h.

85{ return m_targetState; }

◆ terminate()

StatusCode AlgTool::terminate ( )

inlineoverride

Definition at line 81 of file AlgTool.h.

81{ return StatusCode::SUCCESS; }

◆ tools() [1/2]

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

protected

Definition at line 349 of file AlgTool.cpp.

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

◆ tools() [2/2]

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

Definition at line 343 of file AlgTool.cpp.

                                                 {
  if ( !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 87 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 74 of file AlgTool.cpp.

74{ return m_type; }

Friends And Related Symbol Documentation

◆ ToolVisitor

friend class ToolVisitor

friend

Definition at line 57 of file AlgTool.h.

Member Data Documentation

◆ m_auditorFinalize

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

private

Definition at line 289 of file AlgTool.h.

289{ this, "AuditFinalize", false, "trigger auditor on finalize()" };

◆ m_auditorInitialize

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

private

Definition at line 286 of file AlgTool.h.

286{ this, "AuditInitialize", false, "trigger auditor on initialize()" };

◆ m_auditorReinitialize

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

private

Definition at line 290 of file AlgTool.h.

290{ this, "AuditReinitialize", false, "trigger auditor on reinitialize()" };

◆ m_auditorRestart

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

private

Definition at line 291 of file AlgTool.h.

291{ this, "AuditRestart", false, "trigger auditor on restart()" };

◆ m_auditorStart

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

private

Definition at line 287 of file AlgTool.h.

287{ this, "AuditStart", false, "trigger auditor on start()" };

◆ m_auditorStop

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

private

Definition at line 288 of file AlgTool.h.

288{ this, "AuditStop", false, "trigger auditor on stop()" };

◆ m_evtSvc

SmartIF<IDataProviderSvc> AlgTool::m_evtSvc

mutableprivate

Event data service.

Definition at line 269 of file AlgTool.h.

◆ m_interfaceList

InterfaceList AlgTool::m_interfaceList

private

Interface list.

Definition at line 274 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 283 of file AlgTool.h.

283 { this, "MonitorService", "MonitorSvc",

284 "name to use for Monitor Service" };

◆ m_name

const std::string AlgTool::m_name

private

AlgTool full name.

Definition at line 265 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 278 of file AlgTool.h.

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

◆ m_parent

const IInterface* AlgTool::m_parent = nullptr

private

AlgTool parent.

Definition at line 266 of file AlgTool.h.

◆ m_pAuditorSvc

SmartIF<IAuditorSvc> AlgTool::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 272 of file AlgTool.h.

◆ m_pMonitorSvc

SmartIF<IMonitorSvc> AlgTool::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 271 of file AlgTool.h.

◆ m_ptoolSvc

SmartIF<IToolSvc> AlgTool::m_ptoolSvc

mutableprivate

Tool service.

Definition at line 270 of file AlgTool.h.

◆ m_state

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

private

flag indicating whether ToolHandle tools have been added to m_tools

state of the Tool

Definition at line 299 of file AlgTool.h.

◆ m_svcLocator

SmartIF<ISvcLocator> AlgTool::m_svcLocator

mutableprivate

Pointer to Service Locator service.

Definition at line 268 of file AlgTool.h.

◆ m_targetState

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

private

state of the Tool

Definition at line 300 of file AlgTool.h.

◆ m_toolHandleArrays

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

mutableprivate

Definition at line 296 of file AlgTool.h.

◆ m_toolHandles

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

mutableprivate

Definition at line 295 of file AlgTool.h.

◆ m_toolHandlesInit

bool AlgTool::m_toolHandlesInit = false

mutableprivate

Definition at line 297 of file AlgTool.h.

◆ m_tools

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

mutableprivate

Definition at line 294 of file AlgTool.h.

◆ m_type

std::string AlgTool::m_type

private

AlgTool type (concrete class name)

Definition at line 264 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 209 of file AlgTool.h.

◆ ToolSvc

friend AlgTool::ToolSvc

private

Definition at line 56 of file AlgTool.h.

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

GaudiKernel/include/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

Friends

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()

◆ i_cast()

◆ initialize()

◆ initToolHandles()

◆ monitorSvc()

◆ name()

◆ parent()

◆ queryInterface()

◆ registerTool()

◆ reinitialize()

◆ restart()

◆ service() [1/2]

◆ service() [2/2]

◆ serviceLocator()

◆ start()

◆ stop()

◆ svcLoc()

◆ sysFinalize()

◆ sysInitialize()

◆ sysReinitialize()

◆ sysRestart()

◆ sysStart()

◆ sysStop()

◆ targetFSMState()

◆ terminate()

◆ tools() [1/2]

◆ tools() [2/2]

◆ toolSvc()

◆ type()

Friends And Related Symbol Documentation

◆ ToolVisitor

Member Data Documentation

◆ 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

◆ m_svcLocator

◆ m_targetState