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

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

Inheritance diagram for Gaudi::Algorithm:

[legend]

Collaboration diagram for Gaudi::Algorithm:

[legend]

Public Types
typedef Gaudi::PluginService::Factory< IAlgorithm (const std::string &, ISvcLocator )>	Factory

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

Public Types inherited from CommonMessaging< implements< IAlgorithm, 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
	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor. More...

StatusCode	sysStart () override
	Reinitialization method invoked by the framework. More...

StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...

StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework. More...

StatusCode	sysRestart () override
	Restart method invoked by the framework. More...

StatusCode	sysExecute (const EventContext &ctx) override
	The actions to be performed by the algorithm on an event. More...

StatusCode	sysStop () override
	System stop. More...

StatusCode	sysFinalize () override
	System finalization. More...

const std::string &	name () const override
	The identifying name of the algorithm object. More...

const Gaudi::StringKey &	nameKey () const override

const std::string &	type () const override
	The type of the algorithm object. More...

void	setType (std::string type) override

const std::string &	version () const override

unsigned int	index () const override

StatusCode	configure () override
	Dummy implementation of IStateful::configure() method. More...

StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method. More...

StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method More...

StatusCode	start () override
	the default (empty) implementation of IStateful::start() method More...

StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method More...

StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method More...

StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method More...

StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method More...

Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm More...

Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition More...

bool	isEnabled () const override
	Is this algorithm enabled or disabled? More...

bool	isSequence () const override
	Are we a Sequence? More...

unsigned int	errorCount () const
	Get the number of failures of the algorithm. More...

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

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

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

SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...

SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...

SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...

SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...

SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...

SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...

SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...

SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...

SmartIF< IRndmGenSvc > &	randSvc () const
	The standard RandomGen service, Return a pointer to the service if present. More...

SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...

SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...

SmartIF< ITimelineSvc > &	timelineSvc () const

SmartIF< ISvcLocator > &	serviceLocator () const override
	The standard service locator. More...

SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...

SmartIF< IHiveWhiteBoard > &	whiteboard () const

SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const

bool	registerContext () const
	register for Algorithm Context Service? More...

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

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

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

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

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 >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

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

bool	isAsynchronous () const

void	setAsynchronous (bool value)

unsigned int	cardinality () const override
	Return the cardinality. More...

const std::vector< std::string > &	neededResources () const override

AlgExecStateRef	execState (const EventContext &ctx) const override
	get the AlgExecStateRef of current algorithm Actually a small wrapper around it, thus the plain object return type More...

std::ostream &	toControlFlowExpression (std::ostream &os) const override
	Produce string represention of the control flow expression. More...

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, 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< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const *	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< IAlgorithm, 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, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

	requires (!Gaudi::Details::is_gaudi_property_v< TYPE >) Gaudi
	Helper to wrap a regular data member and use it as a regular property. 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	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< IAlgorithm, 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...

Public Attributes
friend	AlgorithmManager

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

bool	isInitialized () const override
	Has the Algorithm already been initialized? More...

bool	isFinalized () const override
	Has the Algorithm already been finalized? More...

void	setIndex (const unsigned int &idx) override
	set instantiation index of Alg More...

bool	isReEntrant () const override

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

Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, 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< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

Private Member Functions
void	initToolHandles () const

unsigned int	maxErrors () const

template<typename IFace >
SmartIF< IFace > &	get_svc_ (SmartIF< IFace > &p, const char *service_name) const

	Algorithm (const Algorithm &)=delete
	delete copy constructor: NO COPY ALLOWED More...

Algorithm &	operator= (const Algorithm &)=delete
	delete assignment operator: NO ASSIGNMENT ALLOWED More...

Private Attributes
Gaudi::StringKey	m_name
	Algorithm's name for identification. More...

std::string	m_type
	Algorithm's type. More...

std::string	m_version
	Algorithm's version. More...

unsigned int	m_index = 0
	Algorithm's index. More...

AlgExecStateRef::AlgKey	m_execSvcKey
	identifier of this algorithm in the AlgExecStateSvc More...

std::vector< IAlgTool * >	m_tools

std::vector< BaseToolHandle * >	m_toolHandles

std::vector< GaudiHandleArrayBase * >	m_toolHandleArrays

SmartIF< IMessageSvc >	m_MS
	Message service. More...

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

SmartIF< IHiveWhiteBoard >	m_WB
	Event data service (whiteboard) More...

SmartIF< IConversionSvc >	m_ECS
	Event conversion service. More...

SmartIF< IDataProviderSvc >	m_DDS
	Detector data service. More...

SmartIF< IConversionSvc >	m_DCS
	Detector conversion service. More...

SmartIF< IHistogramSvc >	m_HDS
	Histogram data service. More...

SmartIF< INTupleSvc >	m_NTS
	N tuple service. More...

SmartIF< IChronoStatSvc >	m_CSS
	Chrono & Stat Service. More...

SmartIF< IRndmGenSvc >	m_RGS
	Random Number Generator Service. More...

SmartIF< IExceptionSvc >	m_EXS
	Exception Handler Service. More...

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

SmartIF< IToolSvc >	m_ptoolSvc
	ToolSvc Service. More...

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

SmartIF< IAlgContextSvc >	m_contextSvc
	Algorithm Context Service. More...

SmartIF< ITimelineSvc >	m_timelineSvc
	Timeline Service. More...

SmartIF< IAlgExecStateSvc >	m_aess
	Alg execution state mgr. More...

SmartIF< ISvcLocator >	m_pSvcLocator
	Pointer to service locator service. More...

Gaudi::Property< int >	m_outputLevel

Gaudi::Property< bool >	m_isEnabled { this, "Enable", true, "should the algorithm be executed or not" }

Gaudi::Property< unsigned int >	m_errorMax { this, "ErrorMax", 1, "[[deprecated]] max number of errors" }

Gaudi::Property< bool >	m_auditorInitialize

Gaudi::Property< bool >	m_auditorReinitialize

Gaudi::Property< bool >	m_auditorRestart

Gaudi::Property< bool >	m_auditorExecute

Gaudi::Property< bool >	m_auditorFinalize

Gaudi::Property< bool >	m_auditorStart

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", m_auditorInitialize.value(), "trigger auditor on stop()" }

Gaudi::Property< bool >	m_doTimeline { this, "Timeline", true, "send events to TimelineSvc" }

Gaudi::Property< std::string >	m_monitorSvcName

Gaudi::Property< bool >	m_registerContext

Gaudi::Property< int >	m_cardinality

Gaudi::Property< std::vector< std::string > >	m_neededResources

Gaudi::Property< bool >	m_asynchronous

Gaudi::Property< bool >	m_filterCircDeps

bool	m_toolHandlesInit = false

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::CONFIGURED
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::CONFIGURED
	Algorithm has been initialized flag. More...

Detailed Description

Base class from which all concrete algorithm classes should be derived.

In order for a concrete algorithm class to do anything useful the methods initialize(), execute() and finalize() should be overridden.

The base class provides utility methods for accessing standard services (event data service etc.); for declaring properties which may be configured by the job options service; and for creating sub algorithms. The only base class functionality which may be used in the constructor of a concrete algorithm is the declaration of member variables as properties. All other functionality, i.e. the use of services and the creation of sub-algorithms, may be used only in initialize() and afterwards (see the Gaudi user guide).

Author: Paul Maley; Pere Mato; David Quarrie

Date: 1998

Definition at line 85 of file Algorithm.h.

Member Typedef Documentation

◆ Factory

typedef Gaudi::PluginService::Factory<IAlgorithm*( const std::string&, ISvcLocator* )> Gaudi::Algorithm::Factory

Definition at line 90 of file Algorithm.h.

Constructor & Destructor Documentation

◆ Algorithm() [1/2]

Gaudi::Algorithm::Algorithm	(	std::string	name,
		ISvcLocator *	svcloc,
		std::string	version = `PACKAGE_VERSION`
	)

inline

Constructor.

Parameters

name	The algorithm object's name
svcloc	A pointer to a service location service

Definition at line 98 of file Algorithm.h.

         : m_name( std::move( name ) )
         , m_version( std::move( version ) ) // incremented by AlgResourcePool
         , m_pSvcLocator( svcloc ) {}

◆ Algorithm() [2/2]

Gaudi::Algorithm::Algorithm ( const Algorithm & )

privatedelete

delete copy constructor: NO COPY ALLOWED

Member Function Documentation

◆ acceptDHVisitor()

void Gaudi::Algorithm::acceptDHVisitor ( IDataHandleVisitor * vis ) const

override

Definition at line 183 of file Algorithm.cpp.

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

◆ addToolsArray()

template<class T >

void Gaudi::Algorithm::addToolsArray ( ToolHandleArray< T > & hndlArr )

inline

Definition at line 369 of file Algorithm.h.

                                                       {
       m_toolHandleArrays.push_back( &hndlArr );
     }

◆ algExecStateSvc()

SmartIF< IAlgExecStateSvc > & Gaudi::Algorithm::algExecStateSvc ( ) const

Definition at line 552 of file Algorithm.cpp.

552 { return get_svc_( m_aess, "AlgExecStateSvc" ); }

◆ auditorSvc()

SmartIF< IAuditorSvc > & Gaudi::Algorithm::auditorSvc ( ) const

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

Definition at line 553 of file Algorithm.cpp.

553 { return get_svc_( m_pAuditorSvc, "AuditorSvc" ); }

◆ cardinality()

unsigned int Gaudi::Algorithm::cardinality ( ) const

inlineoverride

Return the cardinality.

Definition at line 395 of file Algorithm.h.

395 { return m_cardinality; }

◆ chronoSvc()

SmartIF< IChronoStatSvc > & Gaudi::Algorithm::chronoSvc ( ) const

The standard Chrono & Stat service, Return a pointer to the service if present.

Definition at line 554 of file Algorithm.cpp.

554 { return get_svc_( m_CSS, "ChronoStatSvc" ); }

◆ configure()

StatusCode Gaudi::Algorithm::configure ( )

inlineoverride

Dummy implementation of IStateful::configure() method.

Definition at line 170 of file Algorithm.h.

170 { return StatusCode::SUCCESS; }

◆ contextSvc()

SmartIF< IAlgContextSvc > & Gaudi::Algorithm::contextSvc ( ) const

get Algorithm Context Service

Definition at line 564 of file Algorithm.cpp.

564 { return get_svc_( m_contextSvc, "AlgContextSvc" ); }

◆ declareInfo() [1/2]

void Gaudi::Algorithm::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 336 of file Algorithm.h.

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

◆ declareInfo() [2/2]

template<class T >

void Gaudi::Algorithm::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 324 of file Algorithm.h.

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

◆ declareProperty() [1/2]

template<class T >

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

inline

Definition at line 286 of file Algorithm.h.

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

◆ declareProperty() [2/2]

template<class T >

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

inline

Definition at line 295 of file Algorithm.h.

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

◆ declareTool() [1/2]

template<class T >

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

inline

Definition at line 349 of file Algorithm.h.

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

◆ declareTool() [2/2]

template<class T >

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

inline

Definition at line 354 of file Algorithm.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 Gaudi::Algorithm::deregisterTool ( IAlgTool * tool ) const

Definition at line 637 of file Algorithm.cpp.

                                                        {
     std::vector<IAlgTool*>::iterator 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;
     }
   }

◆ detCnvSvc()

SmartIF< IConversionSvc > & Gaudi::Algorithm::detCnvSvc ( ) const

The standard detector data persistency conversion service.

May not be invoked before sysInitialize() has been invoked.

Definition at line 556 of file Algorithm.cpp.

556 { return get_svc_( m_DCS, "DetectorPersistencySvc" ); }

◆ detSvc()

SmartIF< IDataProviderSvc > & Gaudi::Algorithm::detSvc ( ) const

The standard detector data service.

May not be invoked before sysInitialize() has been invoked.

Definition at line 555 of file Algorithm.cpp.

555 { return get_svc_( m_DDS, "DetectorDataSvc" ); }

◆ errorCount()

unsigned int Gaudi::Algorithm::errorCount ( ) const

Get the number of failures of the algorithm.

Definition at line 651 of file Algorithm.cpp.

651 { return m_aess->algErrorCount( static_cast<const IAlgorithm*>( this ) ); }

◆ eventCnvSvc()

SmartIF< IConversionSvc > & Gaudi::Algorithm::eventCnvSvc ( ) const

The standard event data persistency conversion service.

May not be invoked before sysInitialize() has been invoked.

Definition at line 558 of file Algorithm.cpp.

558 { return get_svc_( m_ECS, "EventPersistencySvc" ); }

◆ eventSvc()

SmartIF< IDataProviderSvc > & Gaudi::Algorithm::eventSvc ( ) const

The standard event data service.

May not be invoked before sysInitialize() has been invoked.

Definition at line 557 of file Algorithm.cpp.

557 { return get_svc_( m_EDS, "EventDataSvc" ); }

◆ evtSvc()

SmartIF<IDataProviderSvc>& Gaudi::Algorithm::evtSvc ( ) const

inline

shortcut for method eventSvc

Definition at line 233 of file Algorithm.h.

233 { return eventSvc(); }

◆ exceptionSvc()

SmartIF< IExceptionSvc > & Gaudi::Algorithm::exceptionSvc ( ) const

Get the exception Service.

Definition at line 563 of file Algorithm.cpp.

563 { return get_svc_( m_EXS, "ExceptionSvc" ); }

◆ execState()

AlgExecStateRef Gaudi::Algorithm::execState ( const EventContext & ctx ) const

override

get the AlgExecStateRef of current algorithm Actually a small wrapper around it, thus the plain object return type

Definition at line 536 of file Algorithm.cpp.

                                                                       {
     return { *algExecStateSvc(), ctx, m_execSvcKey };
   }

◆ finalize()

StatusCode Gaudi::Algorithm::finalize ( )

inlineoverride

the default (empty) implementation of IStateful::finalize() method

Definition at line 181 of file Algorithm.h.

181 { return StatusCode::SUCCESS; }

◆ FSMState()

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

inlineoverride

returns the current state of the algorithm

Definition at line 187 of file Algorithm.h.

187 { return m_state; }

◆ get_svc_()

template<typename IFace >

SmartIF< IFace > & Gaudi::Algorithm::get_svc_	(	SmartIF< IFace > &	p,
		const char *	service_name
	)		const

private

Definition at line 541 of file Algorithm.cpp.

                                                                                          {
     if ( !p ) {
       p = this->service( service_name );
       if ( !p ) {
         throw GaudiException( "Service [" + std::string{ service_name } + "] not found", this->name(),
                               StatusCode::FAILURE );
       }
     }
     return p;
   }

◆ histoSvc()

SmartIF< IHistogramSvc > & Gaudi::Algorithm::histoSvc ( ) const

The standard histogram service.

May not be invoked before sysInitialize() has been invoked.

Definition at line 559 of file Algorithm.cpp.

559 { return get_svc_( m_HDS, "HistogramDataSvc" ); }

◆ index()

unsigned int Gaudi::Algorithm::index ( ) const

override

Definition at line 530 of file Algorithm.cpp.

530 { return m_index; }

◆ initialize()

StatusCode Gaudi::Algorithm::initialize ( )

inlineoverride

the default (empty) implementation of IStateful::initialize() method

Definition at line 175 of file Algorithm.h.

175 { return StatusCode::SUCCESS; }

◆ initToolHandles()

void Gaudi::Algorithm::initToolHandles ( ) const

private

Definition at line 572 of file Algorithm.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() ) {
         BaseToolHandle* bth = dynamic_cast<BaseToolHandle*>( toolHandle );
         if ( bth ) {
           init_one( bth );
         } else {
           error() << "Error retrieving ToolHandle " << toolHandle->typeAndName() << " in ToolHandleArray "
                   << thArr->propertyName() << ". Not registered" << endmsg;
         }
       }
     }
  
     for ( BaseToolHandle* th : m_toolHandles ) init_one( th );
  
     m_toolHandlesInit = true;
   }

◆ isAsynchronous()

bool Gaudi::Algorithm::isAsynchronous ( ) const

inline

Definition at line 376 of file Algorithm.h.

376 { return m_asynchronous; }

◆ isEnabled()

bool Gaudi::Algorithm::isEnabled ( ) const

override

Is this algorithm enabled or disabled?

Definition at line 534 of file Algorithm.cpp.

534 { return m_isEnabled; }

◆ isFinalized()

bool Gaudi::Algorithm::isFinalized ( ) const

inlineoverrideprotected

Has the Algorithm already been finalized?

Definition at line 404 of file Algorithm.h.

404 { return Gaudi::StateMachine::CONFIGURED == m_state; }

◆ isInitialized()

bool Gaudi::Algorithm::isInitialized ( ) const

inlineoverrideprotected

Has the Algorithm already been initialized?

Definition at line 401 of file Algorithm.h.

401 { return Gaudi::StateMachine::INITIALIZED == m_state; }

◆ isReEntrant()

bool Gaudi::Algorithm::isReEntrant ( ) const

inlineoverrideprotected

Definition at line 421 of file Algorithm.h.

421 { return true; }

◆ isSequence()

bool Gaudi::Algorithm::isSequence ( ) const

inlineoverride

Are we a Sequence?

Definition at line 195 of file Algorithm.h.

195 { return false; }

◆ maxErrors()

unsigned int Gaudi::Algorithm::maxErrors ( ) const

inlineprivate

Definition at line 418 of file Algorithm.h.

418 { return m_errorMax; }

◆ monitorSvc()

SmartIF<IMonitorSvc>& Gaudi::Algorithm::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 310 of file Algorithm.h.

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

◆ name()

const std::string & Gaudi::Algorithm::name ( ) const

override

The identifying name of the algorithm object.

This is the name of a particular instantiation of an algorithm object as opposed to the name of the algorithm itself, e.g. "LinearTrackFit" may be the name of a concrete algorithm class, whereas "ApproxTrackFit" and "BestTrackFit" may be two instantiations of the class configured to find tracks with different fit criteria.

Definition at line 524 of file Algorithm.cpp.

524 { return m_name.str(); }

◆ nameKey()

const Gaudi::StringKey & Gaudi::Algorithm::nameKey ( ) const

override

Definition at line 526 of file Algorithm.cpp.

526 { return m_name; }

◆ neededResources()

const std::vector<std::string>& Gaudi::Algorithm::neededResources ( ) const

inlineoverride

Definition at line 397 of file Algorithm.h.

397 { return m_neededResources; }

◆ ntupleSvc()

SmartIF< INTupleSvc > & Gaudi::Algorithm::ntupleSvc ( ) const

The standard N tuple service.

Returns a pointer to the N tuple service if present.

Definition at line 560 of file Algorithm.cpp.

560 { return get_svc_( m_NTS, "NTupleSvc" ); }

◆ operator=()

Algorithm& Gaudi::Algorithm::operator= ( const Algorithm & )

privatedelete

delete assignment operator: NO ASSIGNMENT ALLOWED

◆ randSvc()

SmartIF< IRndmGenSvc > & Gaudi::Algorithm::randSvc ( ) const

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

Definition at line 561 of file Algorithm.cpp.

561 { return get_svc_( m_RGS, "RndmGenSvc" ); }

◆ registerContext()

bool Gaudi::Algorithm::registerContext ( ) const

inline

register for Algorithm Context Service?

Definition at line 280 of file Algorithm.h.

280 { return m_registerContext; }

◆ registerTool()

void Gaudi::Algorithm::registerTool ( IAlgTool * tool ) const

Definition at line 632 of file Algorithm.cpp.

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

◆ reinitialize()

StatusCode Gaudi::Algorithm::reinitialize ( )

override

the default (empty) implementation of IStateful::reinitialize() method

Definition at line 489 of file Algorithm.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 Gaudi::Algorithm::restart ( )

override

the default (empty) implementation of IStateful::restart() method

Definition at line 509 of file Algorithm.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]

template<class T >

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

inline

Definition at line 204 of file Algorithm.h.

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

◆ service() [2/2]

SmartIF< IService > Gaudi::Algorithm::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")

Protected Member Functions.

Definition at line 627 of file Algorithm.cpp.

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

◆ serviceLocator()

SmartIF< ISvcLocator > & Gaudi::Algorithm::serviceLocator ( ) const

override

The standard service locator.

Returns a pointer to the service locator service. This service may be used by an algorithm to request any services it requires in addition to those provided by default.

Definition at line 568 of file Algorithm.cpp.

                                                         {
     return *const_cast<SmartIF<ISvcLocator>*>( &m_pSvcLocator );
   }

◆ setAsynchronous()

void Gaudi::Algorithm::setAsynchronous ( bool value )

inline

Definition at line 378 of file Algorithm.h.

378 { m_asynchronous = value; }

◆ setIndex()

void Gaudi::Algorithm::setIndex ( const unsigned int & idx )

overrideprotected

set instantiation index of Alg

Definition at line 532 of file Algorithm.cpp.

532 { m_index = idx; }

◆ setType()

void Gaudi::Algorithm::setType ( std::string type )

inlineoverride

Definition at line 163 of file Algorithm.h.

163 { m_type = std::move( type ); } // BH, TODO: move to proper place

◆ start()

StatusCode Gaudi::Algorithm::start ( )

inlineoverride

the default (empty) implementation of IStateful::start() method

Definition at line 177 of file Algorithm.h.

177 { return StatusCode::SUCCESS; }

◆ stop()

StatusCode Gaudi::Algorithm::stop ( )

inlineoverride

the default (empty) implementation of IStateful::stop() method

Definition at line 179 of file Algorithm.h.

179 { return StatusCode::SUCCESS; }

◆ svcLoc()

SmartIF<ISvcLocator>& Gaudi::Algorithm::svcLoc ( ) const

inline

shortcut for method serviceLocator

Definition at line 273 of file Algorithm.h.

273 { return serviceLocator(); }

◆ sysExecute()

StatusCode Gaudi::Algorithm::sysExecute ( const EventContext & ctx )

override

The actions to be performed by the algorithm on an event.

This method is invoked once per event for top level algorithms by the application manager. This method invokes execute() method. For sub-algorithms either the sysExecute() method or execute() method must be EXPLICITLY invoked by the parent algorithm.

Definition at line 322 of file Algorithm.cpp.

                                                             {
     if ( !isEnabled() ) {
       if ( msgLevel( MSG::VERBOSE ) ) { verbose() << ".sysExecute(): is not enabled. Skip execution" << endmsg; }
       return StatusCode::SUCCESS;
     }
  
     AlgExecStateRef algState{ *algExecStateSvc(), ctx, m_execSvcKey };
     algState.setState( AlgExecState::Executing );
     StatusCode status;
  
     // Should performance profile be performed ?
     // invoke execute() method of Algorithm class
     //   and catch all uncaught exceptions
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr, ctx );
  
     Gaudi::Guards::AuditorGuard guard( name(),
                                        // check if we want to audit the initialize
                                        ( m_auditorExecute ) ? auditorSvc().get() : nullptr, IAuditor::Execute, status,
                                        ctx );
  
     try {
       ITimelineSvc::TimelineRecorder timelineRecoder;
       if ( m_doTimeline ) { timelineRecoder = timelineSvc()->getRecorder( name(), ctx ); }
  
       status = execute( ctx );
  
       if ( status == Gaudi::Functional::FilterDecision::FAILED ) {
         algState.setFilterPassed( false );
       } else if ( status.isFailure() ) {
         status = exceptionSvc()->handleErr( *this, status );
       }
  
     } catch ( const GaudiException& Exception ) {
  
       if ( Exception.code() == StatusCode::FAILURE ) {
         fatal();
       } else {
         error() << " Recoverable";
       }
  
       msgStream() << " Exception with tag=" << Exception.tag() << " is caught " << endmsg;
  
       error() << Exception << endmsg;
  
       // Stat stat( chronoSvc() , Exception.tag() ) ;
       status = exceptionSvc()->handle( *this, Exception );
     } catch ( const std::exception& Exception ) {
  
       fatal() << "Standard std::exception is caught in " << __func__ << endmsg;
       error() << Exception.what() << endmsg;
       // Stat stat( chronoSvc() , "*std::exception*" ) ;
       status = exceptionSvc()->handle( *this, Exception );
     } catch ( ... ) {
  
       fatal() << "UNKNOWN Exception is caught " << endmsg;
       // Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
  
       status = exceptionSvc()->handle( *this );
     }
  
     if ( status.isFailure() ) {
       // Increment the error count
       unsigned int nerr = m_aess->incrementErrorCount( this );
       // Check if maximum is exeeded
       if ( nerr < m_errorMax ) {
         warning() << "Continuing from error (cnt=" << nerr << ", max=" << m_errorMax << ")" << endmsg;
         // convert to success
         status = StatusCode::SUCCESS;
       } else {
         error() << "Maximum number of errors (" << m_errorMax << ") reached." << endmsg;
       }
     }
  
     algState.setState( AlgExecState::Done, status );
  
     return status;
   }

◆ sysFinalize()

StatusCode Gaudi::Algorithm::sysFinalize ( )

override

System finalization.

This method invokes the finalize() method of a concrete algorithm and the finalize() methods of all of that algorithm's sub algorithms.

Definition at line 447 of file Algorithm.cpp.

                                     {
  
     // Bypass the finalialization if the algorithm hasn't been initilized.
     if ( Gaudi::StateMachine::CONFIGURED == FSMState() || !isEnabled() ) return StatusCode::SUCCESS;
  
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::FINALIZE, m_state );
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr );
  
     StatusCode sc( StatusCode::FAILURE );
     // Invoke finalize() method of the derived class inside a try/catch clause
     try {
       { // limit the scope of the guard
         Gaudi::Guards::AuditorGuard guard( name(),
                                            // check if we want to audit the initialize
                                            ( m_auditorFinalize ) ? auditorSvc().get() : nullptr, IAuditor::Finalize );
         // Invoke the finalize() method of the derived class
         sc = finalize();
       }
       if ( sc.isSuccess() ) {
         // Indicate that this Algorithm has been finalized to prevent duplicate attempts
         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() );
       sc = StatusCode::FAILURE;
     } catch ( const std::exception& Exception ) {
       fatal() << "Standard std::exception is caught in " << __func__ << endmsg;
       error() << Exception.what() << endmsg;
       Stat stat( chronoSvc(), "*std::exception*" );
       sc = StatusCode::FAILURE;
     } catch ( ... ) {
       fatal() << "UNKNOWN Exception is caught " << endmsg;
       Stat stat( chronoSvc(), "*UNKNOWN Exception*" );
       sc = StatusCode::FAILURE;
     }
     return sc;
   }

◆ sysInitialize()

StatusCode Gaudi::Algorithm::sysInitialize ( )

override

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Definition at line 53 of file Algorithm.cpp.

                                       {
  
     // Bypass the initialization if the algorithm
     // has already been initialized.
     if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
  
     // 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();
  
     // Set the Algorithm's properties
     bindPropertiesTo( serviceLocator()->getOptsSvc() );
  
     // Bypass the initialization if the algorithm is disabled.
     // Need to do this after setProperties.
     if ( !isEnabled() ) return StatusCode::SUCCESS;
  
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::INITIALIZE, m_state );
  
     // TODO: (MCl) where should we do this? initialize or start?
     // Reset Error count
     // m_errorCount = 0;
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr );
  
     // Get WhiteBoard interface if implemented by EventDataSvc
     m_WB = service( "EventDataSvc" );
  
     // check whether timeline should be done
     m_doTimeline = timelineSvc()->isEnabled();
  
     StatusCode sc;
     // Invoke initialize() method of the derived class inside a try/catch clause
     try {
  
       { // limit the scope of the guard
         Gaudi::Guards::AuditorGuard guard( name(),
                                            // check if we want to audit the initialize
                                            ( m_auditorInitialize ) ? auditorSvc().get() : nullptr,
                                            IAuditor::Initialize );
         // Invoke the initialize() method of the derived class
         sc = initialize();
       }
  
       if ( sc.isSuccess() ) {
         // Update the state.
         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() );
       sc = StatusCode::FAILURE;
     } catch ( const std::exception& Exception ) {
       fatal() << "Standard std::exception is caught in " << __func__ << endmsg;
       error() << Exception.what() << endmsg;
       Stat stat( chronoSvc(), "*std::exception*" );
       sc = StatusCode::FAILURE;
     } catch ( ... ) {
       fatal() << "UNKNOWN Exception is caught " << endmsg;
       Stat stat( chronoSvc(), "*UNKNOWN Exception*" );
       sc = StatusCode::FAILURE;
     }
  
     m_execSvcKey = algExecStateSvc()->addAlg( this );
  
     //
     //
  
     // ignore this step if we're a Sequence
     if ( this->isSequence() ) { return sc; }
  
     if ( msgLevel( MSG::DEBUG ) ) {
       debug() << "input handles: " << inputHandles().size() << endmsg;
       debug() << "output handles: " << outputHandles().size() << endmsg;
     }
  
     // 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() ) {
         // TODO: this case leads to a segfault as the SC, seemingly, is not propagated up properly
         error() << "Explicit circular data dependency detected for id " << h->fullKey() << endmsg;
         sc = StatusCode::FAILURE;
       }
     }
  
     if ( !sc ) return sc;
  
     if ( m_updateDataHandles ) acceptDHVisitor( m_updateDataHandles.get() );
  
     // visit all sub-algs and tools, build full set. First initialize ToolHandles if needed
     try {
       if ( !m_toolHandlesInit ) initToolHandles();
     } catch ( const GaudiException& Exception ) {
       error() << "Failing initializing ToolHandles : " << Exception << endmsg;
       return StatusCode::FAILURE;
     }
     DHHVisitor avis( m_inputDataObjs, m_outputDataObjs );
     acceptDHVisitor( &avis );
  
     // check for implicit circular data deps from child Algs/AlgTools
     for ( auto& h : m_outputDataObjs ) {
       auto i = m_inputDataObjs.find( h );
       if ( i != m_inputDataObjs.end() ) {
         if ( m_filterCircDeps ) {
           warning() << "Implicit circular data dependency detected for id " << h << endmsg;
           m_inputDataObjs.erase( i );
         } else {
           error() << "Implicit circular data dependency detected for id " << h << endmsg;
           sc = StatusCode::FAILURE;
         }
       }
     }
  
     if ( !sc ) return sc;
  
     if ( msgLevel( MSG::DEBUG ) && !avis.empty() ) { debug() << "data dependencies:" << avis << endmsg; }
  
     // initialize handles
     initDataHandleHolder();
  
     return sc;
   }

◆ sysReinitialize()

StatusCode Gaudi::Algorithm::sysReinitialize ( )

override

Reinitialization method invoked by the framework.

This method is responsible for any reinitialization required by the framework itself. It will in turn invoke the reinitialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Definition at line 235 of file Algorithm.cpp.

                                         {
  
     // Bypass the initialization if the algorithm is disabled.
     if ( !isEnabled() ) return StatusCode::SUCCESS;
  
     // Check that the current status is the correct one.
     if ( Gaudi::StateMachine::INITIALIZED != FSMState() ) {
       error() << "sysReinitialize(): cannot reinitialize algorithm not initialized" << endmsg;
       return StatusCode::FAILURE;
     }
  
     // Reset Error count
     // m_errorCount = 0; // done during start
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr );
  
     StatusCode sc( StatusCode::SUCCESS );
     // Invoke reinitialize() method of the derived class inside a try/catch clause
     try {
       Gaudi::Guards::AuditorGuard guard( name(),
                                          // check if we want to audit the initialize
                                          ( m_auditorReinitialize ) ? auditorSvc().get() : nullptr,
                                          IAuditor::ReInitialize );
       // Invoke the reinitialize() method of the derived class
       sc = reinitialize();
     } catch ( const GaudiException& Exception ) {
       fatal() << "sysReinitialize(): Exception with tag=" << Exception.tag() << " is caught" << endmsg;
       error() << Exception << endmsg;
       Stat stat( chronoSvc(), Exception.tag() );
       sc = StatusCode::FAILURE;
     } catch ( const std::exception& Exception ) {
       fatal() << "sysReinitialize(): Standard std::exception is caught" << endmsg;
       error() << Exception.what() << endmsg;
       Stat stat( chronoSvc(), "*std::exception*" );
       sc = StatusCode::FAILURE;
     } catch ( ... ) {
       fatal() << "sysReinitialize(): UNKNOWN Exception is caught" << endmsg;
       Stat stat( chronoSvc(), "*UNKNOWN Exception*" );
       sc = StatusCode::FAILURE;
     }
  
     return sc;
   }

◆ sysRestart()

StatusCode Gaudi::Algorithm::sysRestart ( )

override

Restart method invoked by the framework.

It will in turn invoke the restart() method of the derived algorithm, and of any sub-algorithms which it creates.

Definition at line 281 of file Algorithm.cpp.

                                    {
  
     // Bypass the initialization if the algorithm is disabled.
     if ( !isEnabled() ) return StatusCode::SUCCESS;
  
     // Check that the current status is the correct one.
     if ( Gaudi::StateMachine::RUNNING != FSMState() ) {
       error() << "sysRestart(): cannot restart algorithm not started" << endmsg;
       return StatusCode::FAILURE;
     }
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr );
  
     StatusCode sc( StatusCode::FAILURE );
     // Invoke reinitialize() method of the derived class inside a try/catch clause
     try {
       Gaudi::Guards::AuditorGuard guard( name(),
                                          // check if we want to audit the initialize
                                          ( m_auditorRestart ) ? auditorSvc().get() : nullptr, IAuditor::ReStart );
       // Invoke the reinitialize() method of the derived class
       sc = restart();
     } catch ( const GaudiException& Exception ) {
       fatal() << "sysRestart(): Exception with tag=" << Exception.tag() << " is caught" << endmsg;
       error() << Exception << endmsg;
       Stat stat( chronoSvc(), Exception.tag() );
       sc = StatusCode::FAILURE;
     } catch ( const std::exception& Exception ) {
       fatal() << "sysRestart(): Standard std::exception is caught" << endmsg;
       error() << Exception.what() << endmsg;
       Stat stat( chronoSvc(), "*std::exception*" );
       sc = StatusCode::FAILURE;
     } catch ( ... ) {
       fatal() << "sysRestart(): UNKNOWN Exception is caught" << endmsg;
       Stat stat( chronoSvc(), "*UNKNOWN Exception*" );
       sc = StatusCode::FAILURE;
     }
  
     return sc;
   }

◆ sysStart()

StatusCode Gaudi::Algorithm::sysStart ( )

override

Reinitialization method invoked by the framework.

This method is responsible for any reinitialization required by the framework itself. It will in turn invoke the reinitialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Definition at line 191 of file Algorithm.cpp.

                                  {
  
     // Bypass the startup if already running or disabled.
     if ( Gaudi::StateMachine::RUNNING == FSMState() || !isEnabled() ) return StatusCode::SUCCESS;
  
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::START, m_state );
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr );
  
     StatusCode sc( StatusCode::FAILURE );
     // Invoke start() method of the derived class inside a try/catch clause
     try {
       { // limit the scope of the guard
         Gaudi::Guards::AuditorGuard guard( name(),
                                            // check if we want to audit the initialize
                                            ( m_auditorStart ) ? auditorSvc().get() : nullptr, IAuditor::Start );
         // Invoke the start() method of the derived class
         sc = start();
       }
       if ( sc.isSuccess() ) {
         // Update the state.
         m_state = m_targetState;
       }
     } catch ( const GaudiException& Exception ) {
       fatal() << "in sysStart(): exception with tag=" << Exception.tag() << " is caught" << endmsg;
       error() << Exception << endmsg;
       Stat stat( chronoSvc(), Exception.tag() );
       sc = StatusCode::FAILURE;
     } catch ( const std::exception& Exception ) {
       fatal() << "in sysStart(): standard std::exception is caught" << endmsg;
       error() << Exception.what() << endmsg;
       Stat stat( chronoSvc(), "*std::exception*" );
       sc = StatusCode::FAILURE;
     } catch ( ... ) {
       fatal() << "in sysStart(): UNKNOWN Exception is caught" << endmsg;
       Stat stat( chronoSvc(), "*UNKNOWN Exception*" );
       sc = StatusCode::FAILURE;
     }
  
     return sc;
   }

◆ sysStop()

StatusCode Gaudi::Algorithm::sysStop ( )

override

System stop.

This method invokes the stop() method of a concrete algorithm and the stop() methods of all of that algorithm's sub algorithms.

Definition at line 403 of file Algorithm.cpp.

                                 {
  
     // Bypass the startup if already running or disabled.
     if ( Gaudi::StateMachine::INITIALIZED == FSMState() || !isEnabled() ) return StatusCode::SUCCESS;
  
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::STOP, m_state );
  
     // lock the context service
     Gaudi::Utils::AlgContext cnt( this, registerContext() ? contextSvc().get() : nullptr );
  
     StatusCode sc( StatusCode::FAILURE );
     // Invoke stop() method of the derived class inside a try/catch clause
     try {
       { // limit the scope of the guard
         Gaudi::Guards::AuditorGuard guard( name(),
                                            // check if we want to audit the initialize
                                            ( m_auditorStop ) ? auditorSvc().get() : nullptr, IAuditor::Stop );
  
         // Invoke the stop() method of the derived class
         sc = stop();
       }
       if ( sc.isSuccess() ) {
         // Update the state.
         m_state = m_targetState;
       }
     } catch ( const GaudiException& Exception ) {
       fatal() << "in sysStop(): exception with tag=" << Exception.tag() << " is caught" << endmsg;
       error() << Exception << endmsg;
       Stat stat( chronoSvc(), Exception.tag() );
       sc = StatusCode::FAILURE;
     } catch ( const std::exception& Exception ) {
       fatal() << "in sysStop(): standard std::exception is caught" << endmsg;
       error() << Exception.what() << endmsg;
       Stat stat( chronoSvc(), "*std::exception*" );
       sc = StatusCode::FAILURE;
     } catch ( ... ) {
       fatal() << "in sysStop(): UNKNOWN Exception is caught" << endmsg;
       Stat stat( chronoSvc(), "*UNKNOWN Exception*" );
       sc = StatusCode::FAILURE;
     }
  
     return sc;
   }

◆ targetFSMState()

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

inlineoverride

returns the state the algorithm will be in after the ongoing transition

Definition at line 189 of file Algorithm.h.

189 { return m_targetState; }

◆ terminate()

StatusCode Gaudi::Algorithm::terminate ( )

inlineoverride

Dummy implementation of IStateful::terminate() method.

Definition at line 172 of file Algorithm.h.

172 { return StatusCode::SUCCESS; }

◆ timelineSvc()

SmartIF< ITimelineSvc > & Gaudi::Algorithm::timelineSvc ( ) const

Definition at line 565 of file Algorithm.cpp.

565 { return get_svc_( m_timelineSvc, "TimelineSvc" ); }

◆ toControlFlowExpression()

std::ostream & Gaudi::Algorithm::toControlFlowExpression ( std::ostream & os ) const

override

Produce string represention of the control flow expression.

Definition at line 647 of file Algorithm.cpp.

                                                                        {
     return os << type() << "('" << name() << "')";
   }

◆ tools() [1/2]

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

protected

Definition at line 618 of file Algorithm.cpp.

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

◆ tools() [2/2]

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

Definition at line 613 of file Algorithm.cpp.

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

◆ toolSvc()

SmartIF< IToolSvc > & Gaudi::Algorithm::toolSvc ( ) const

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

Definition at line 562 of file Algorithm.cpp.

562 { return get_svc_( m_ptoolSvc, "ToolSvc" ); }

◆ type()

const std::string& Gaudi::Algorithm::type ( ) const

inlineoverride

The type of the algorithm object.

Definition at line 162 of file Algorithm.h.

162 { return m_type; }

◆ version()

const std::string & Gaudi::Algorithm::version ( ) const

override

Definition at line 528 of file Algorithm.cpp.

528 { return m_version; }

◆ whiteboard()

SmartIF< IHiveWhiteBoard > & Gaudi::Algorithm::whiteboard ( ) const

Definition at line 566 of file Algorithm.cpp.

566 { return get_svc_( m_WB, "EventDataSvc" ); }

Member Data Documentation

◆ AlgorithmManager

friend Gaudi::Algorithm::AlgorithmManager

Definition at line 92 of file Algorithm.h.

◆ m_aess

SmartIF<IAlgExecStateSvc> Gaudi::Algorithm::m_aess

mutableprivate

Alg execution state mgr.

Definition at line 458 of file Algorithm.h.

◆ m_asynchronous

Gaudi::Property<bool> Gaudi::Algorithm::m_asynchronous

private

Initial value:

{ this, "Asynchronous", false,
                                          "whether algorithm is asynchronous and uses Boost Fiber to suspend "
                                          "while offloaded code is running." }

Definition at line 503 of file Algorithm.h.

◆ m_auditorExecute

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorExecute

private

Initial value:

{ this, "AuditExecute", m_auditorInitialize.value(),

"trigger auditor on execute()" }

Definition at line 482 of file Algorithm.h.

◆ m_auditorFinalize

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorFinalize

private

Initial value:

{ this, "AuditFinalize", m_auditorInitialize.value(),

"trigger auditor on finalize()" }

Definition at line 484 of file Algorithm.h.

◆ m_auditorInitialize

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorInitialize

private

Initial value:

{

this, "AuditInitialize", Details::getDefaultAuditorValue( m_pSvcLocator ), "trigger auditor on initialize()" }

Definition at line 476 of file Algorithm.h.

◆ m_auditorReinitialize

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorReinitialize

private

Initial value:

{ this, "AuditReinitialize", m_auditorInitialize.value(),

"trigger auditor on reinitialize()" }

Definition at line 478 of file Algorithm.h.

◆ m_auditorRestart

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorRestart

private

Initial value:

{ this, "AuditRestart", m_auditorInitialize.value(),

"trigger auditor on restart()" }

Definition at line 480 of file Algorithm.h.

◆ m_auditorStart

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorStart

private

Initial value:

{ this, "AuditStart", m_auditorInitialize.value(),

"trigger auditor on start()" }

Definition at line 486 of file Algorithm.h.

◆ m_auditorStop

Gaudi::Property<bool> Gaudi::Algorithm::m_auditorStop { this, "AuditStop", m_auditorInitialize.value(), "trigger auditor on stop()" }

private

Definition at line 488 of file Algorithm.h.

◆ m_cardinality

Gaudi::Property<int> Gaudi::Algorithm::m_cardinality

private

Initial value:

{ this, "Cardinality", 0,

"how many clones to create - 0 means algo is reentrant" }

Definition at line 498 of file Algorithm.h.

◆ m_contextSvc

SmartIF<IAlgContextSvc> Gaudi::Algorithm::m_contextSvc

mutableprivate

Algorithm Context Service.

Definition at line 455 of file Algorithm.h.

◆ m_CSS

SmartIF<IChronoStatSvc> Gaudi::Algorithm::m_CSS

mutableprivate

Chrono & Stat Service.

Definition at line 449 of file Algorithm.h.

◆ m_DCS

SmartIF<IConversionSvc> Gaudi::Algorithm::m_DCS

mutableprivate

Detector conversion service.

Definition at line 446 of file Algorithm.h.

◆ m_DDS

SmartIF<IDataProviderSvc> Gaudi::Algorithm::m_DDS

mutableprivate

Detector data service.

Definition at line 445 of file Algorithm.h.

◆ m_doTimeline

Gaudi::Property<bool> Gaudi::Algorithm::m_doTimeline { this, "Timeline", true, "send events to TimelineSvc" }

private

Definition at line 490 of file Algorithm.h.

◆ m_ECS

SmartIF<IConversionSvc> Gaudi::Algorithm::m_ECS

mutableprivate

Event conversion service.

Definition at line 444 of file Algorithm.h.

◆ m_EDS

SmartIF<IDataProviderSvc> Gaudi::Algorithm::m_EDS

mutableprivate

Event data service.

Definition at line 442 of file Algorithm.h.

◆ m_errorMax

Gaudi::Property<unsigned int> Gaudi::Algorithm::m_errorMax { this, "ErrorMax", 1, "[[deprecated]] max number of errors" }

private

Definition at line 474 of file Algorithm.h.

◆ m_execSvcKey

AlgExecStateRef::AlgKey Gaudi::Algorithm::m_execSvcKey

private

identifier of this algorithm in the AlgExecStateSvc

Definition at line 430 of file Algorithm.h.

◆ m_EXS

SmartIF<IExceptionSvc> Gaudi::Algorithm::m_EXS

mutableprivate

Exception Handler Service.

Definition at line 451 of file Algorithm.h.

◆ m_filterCircDeps

Gaudi::Property<bool> Gaudi::Algorithm::m_filterCircDeps

private

Initial value:

{ this, "FilterCircularDependencies", true,

"filter out circular data dependencies" }

Definition at line 507 of file Algorithm.h.

◆ m_HDS

SmartIF<IHistogramSvc> Gaudi::Algorithm::m_HDS

mutableprivate

Histogram data service.

Definition at line 447 of file Algorithm.h.

◆ m_index

unsigned int Gaudi::Algorithm::m_index = 0

private

Algorithm's index.

Definition at line 427 of file Algorithm.h.

◆ m_isEnabled

Gaudi::Property<bool> Gaudi::Algorithm::m_isEnabled { this, "Enable", true, "should the algorithm be executed or not" }

private

Definition at line 472 of file Algorithm.h.

◆ m_monitorSvcName

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

private

Initial value:

{ this, "MonitorService", "MonitorSvc",

"name to use for Monitor Service" }

Definition at line 492 of file Algorithm.h.

◆ m_MS

SmartIF<IMessageSvc> Gaudi::Algorithm::m_MS

mutableprivate

Message service.

Definition at line 441 of file Algorithm.h.

◆ m_name

Gaudi::StringKey Gaudi::Algorithm::m_name

private

Algorithm's name for identification.

Definition at line 424 of file Algorithm.h.

◆ m_neededResources

Gaudi::Property<std::vector<std::string> > Gaudi::Algorithm::m_neededResources

private

Initial value:

{

this, "NeededResources", {}, "named resources needed during event looping" }

Definition at line 500 of file Algorithm.h.

◆ m_NTS

SmartIF<INTupleSvc> Gaudi::Algorithm::m_NTS

mutableprivate

N tuple service.

Definition at line 448 of file Algorithm.h.

◆ m_outputLevel

Gaudi::Property<int> Gaudi::Algorithm::m_outputLevel

private

Initial value:

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

Definition at line 468 of file Algorithm.h.

◆ m_pAuditorSvc

SmartIF<IAuditorSvc> Gaudi::Algorithm::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 452 of file Algorithm.h.

◆ m_pMonitorSvc

SmartIF<IMonitorSvc> Gaudi::Algorithm::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 454 of file Algorithm.h.

◆ m_pSvcLocator

SmartIF<ISvcLocator> Gaudi::Algorithm::m_pSvcLocator

private

Pointer to service locator service.

Definition at line 460 of file Algorithm.h.

◆ m_ptoolSvc

SmartIF<IToolSvc> Gaudi::Algorithm::m_ptoolSvc

mutableprivate

ToolSvc Service.

Definition at line 453 of file Algorithm.h.

◆ m_registerContext

Gaudi::Property<bool> Gaudi::Algorithm::m_registerContext

private

Initial value:

{ this, "RegisterForContextService", false,

"flag to enforce the registration for Algorithm Context Service" }

Definition at line 495 of file Algorithm.h.

◆ m_RGS

SmartIF<IRndmGenSvc> Gaudi::Algorithm::m_RGS

mutableprivate

Random Number Generator Service.

Definition at line 450 of file Algorithm.h.

◆ m_state

Gaudi::StateMachine::State Gaudi::Algorithm::m_state = Gaudi::StateMachine::CONFIGURED

private

flag indicating whether ToolHandle tools have been added to m_tools

Algorithm has been initialized flag

Definition at line 512 of file Algorithm.h.

◆ m_targetState

Gaudi::StateMachine::State Gaudi::Algorithm::m_targetState = Gaudi::StateMachine::CONFIGURED

private

Algorithm has been initialized flag.

Definition at line 513 of file Algorithm.h.

◆ m_timelineSvc

SmartIF<ITimelineSvc> Gaudi::Algorithm::m_timelineSvc

mutableprivate

Timeline Service.

Definition at line 457 of file Algorithm.h.

◆ m_toolHandleArrays

std::vector<GaudiHandleArrayBase*> Gaudi::Algorithm::m_toolHandleArrays

mutableprivate

Definition at line 435 of file Algorithm.h.

◆ m_toolHandles

std::vector<BaseToolHandle*> Gaudi::Algorithm::m_toolHandles

mutableprivate

Definition at line 434 of file Algorithm.h.

◆ m_toolHandlesInit

bool Gaudi::Algorithm::m_toolHandlesInit = false

mutableprivate

Definition at line 510 of file Algorithm.h.

◆ m_tools

std::vector<IAlgTool*> Gaudi::Algorithm::m_tools

mutableprivate

Definition at line 433 of file Algorithm.h.

◆ m_type

std::string Gaudi::Algorithm::m_type

private

Algorithm's type.

Definition at line 425 of file Algorithm.h.

◆ m_updateDataHandles

std::unique_ptr<IDataHandleVisitor> Gaudi::Algorithm::m_updateDataHandles

protected

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

Definition at line 464 of file Algorithm.h.

◆ m_version

std::string Gaudi::Algorithm::m_version

private

Algorithm's version.

Definition at line 426 of file Algorithm.h.

◆ m_WB

SmartIF<IHiveWhiteBoard> Gaudi::Algorithm::m_WB

mutableprivate

Event data service (whiteboard)

Definition at line 443 of file Algorithm.h.

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

GaudiKernel/include/Gaudi/Algorithm.h
GaudiKernel/src/Lib/Algorithm.cpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Factory

Constructor & Destructor Documentation

◆ Algorithm() [1/2]

◆ Algorithm() [2/2]

Member Function Documentation

◆ acceptDHVisitor()

◆ addToolsArray()

◆ algExecStateSvc()

◆ auditorSvc()

◆ cardinality()

◆ chronoSvc()

◆ configure()

◆ contextSvc()

◆ declareInfo() [1/2]

◆ declareInfo() [2/2]

◆ declareProperty() [1/2]

◆ declareProperty() [2/2]

◆ declareTool() [1/2]

◆ declareTool() [2/2]

◆ deregisterTool()

◆ detCnvSvc()

◆ detSvc()

◆ errorCount()

◆ eventCnvSvc()

◆ eventSvc()

◆ evtSvc()

◆ exceptionSvc()

◆ execState()

◆ finalize()

◆ FSMState()

◆ get_svc_()

◆ histoSvc()

◆ index()

◆ initialize()

◆ initToolHandles()

◆ isAsynchronous()

◆ isEnabled()

◆ isFinalized()

◆ isInitialized()

◆ isReEntrant()

◆ isSequence()

◆ maxErrors()

◆ monitorSvc()

◆ name()

◆ nameKey()

◆ neededResources()

◆ ntupleSvc()

◆ operator=()

◆ randSvc()

◆ registerContext()

◆ registerTool()

◆ reinitialize()

◆ restart()

◆ service() [1/2]

◆ service() [2/2]

◆ serviceLocator()

◆ setAsynchronous()

◆ setIndex()

◆ setType()

◆ start()

◆ stop()

◆ svcLoc()

◆ sysExecute()

◆ sysFinalize()

◆ sysInitialize()

◆ sysReinitialize()

◆ sysRestart()

◆ sysStart()

◆ sysStop()

◆ targetFSMState()

◆ terminate()