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

#include <GaudiKernel/Algorithm.h>

Inheritance diagram for Algorithm:

[legend]

Collaboration diagram for Algorithm:

[legend]

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

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 (const std::string &name, ISvcLocator *svcloc, const 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...

StatusCode	sysBeginRun () override
	beginRun method invoked by the framework. More...

StatusCode	sysEndRun () override
	endRun method invoked by the framework. 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 (const 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	isExecuted () const override
	Has this algorithm been executed since the last reset? More...

void	setExecuted (bool state) const override
	Set the executed flag to the specified state. More...

void	resetExecuted () override
	Reset the executed state of the Algorithm for the duration of the current event. More...

StatusCode	beginRun () override
	Algorithm begin run. More...

StatusCode	endRun () override
	Algorithm end run. This method is called at the end of the event loop. More...

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

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

bool	filterPassed () const override
	Did this algorithm pass or fail its filter criterion for the last event? More...

void	setFilterPassed (bool state) const override
	Set the filter passed flag to the specified state. More...

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

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

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

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

template<class T >
SmartIF< T >	service (const std::string &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< IChronoStatSvc > &	chronoStatService () const

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

SmartIF< IDataProviderSvc > &	detDataService () const

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

SmartIF< IConversionSvc > &	detDataCnvService () const

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

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

SmartIF< IDataProviderSvc > &	eventDataService () const

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

SmartIF< IConversionSvc > &	eventDataCnvService () const

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

SmartIF< IHistogramSvc > &	histogramDataService () const

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

SmartIF< INTupleSvc > &	ntupleService () const

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

StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...

const std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

std::vector< Algorithm * > *	subAlgorithms ()
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...

StatusCode	setProperties ()
	Set the algorithm's properties. 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...

const EventContext &	getContext () const override
	get the context More...

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, std::string toolTypeAndName, bool createIf=true)

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

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

bool	isIOBound () const

void	setIOBound (bool value)

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

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

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 > > > >
	DataHandleHolderBase (Args &&...args)
	NOTE: Cannot use "using Super::Super;" due to a GCC 6 bug. More...

void	registerDataHandle (Gaudi::v2::DataHandle &handle) final override
	Register a data handle of this algorithm/tool. More...

void	addDataDependency (const DataObjID &key, AccessMode access) final override
	Add a data dependency, even after initialization. More...

const DataObjIDColl &	dataDependencies (AccessMode access) const final override
	Tell which whiteboard keys the algorithm will be reading or writing. More...

void	declare (Gaudi::v1::DataHandle &handle) override
	Declare ownership of a legacy DataHandle. More...

void	renounce (Gaudi::v1::DataHandle &handle) override
	Discard ownership of a legacy DataHandle. More...

const DataObjIDColl *	allDataDependencies () const final override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

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

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< 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, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

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

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

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

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

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

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

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

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

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

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

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AlgExecState &	execState (const EventContext &ctx) const
	reference to AlgExecState of Alg More...

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void	updateDataDependencies (const DataObjIDMapping &keyMap)
	Update the key of each registered data dependency, using a user-defined mapping from the old to the new key. More...

void	collectExplicitDataDependencies ()
	Collect all explicit data dependencies in a single place. More...

StatusCode	handleCircularDataDependencies (CircularDepHandler &&circularDepHandler)
	Look for circular dependencies and let a user-specified handler deal with each of them. More...

void	collectImplicitDataDependencies (const IDataHandleHolder *child)
	Add the dependencies of another DataHandleHolder to our dependency list. More...

const DataObjIDColl &	ignoredDataDependencies (AccessMode access) const
	Tell which data dependencies have been ignored due to an empty key. More...

void	initializeDataHandleHolder ()
	Initialize the DataHandles. More...

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

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
DataObjIDMapping	m_updateDependencies
	Hook for for derived classes to alter the DataObjID of dependencies. More...

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

StatusCode	service_i (const std::string &svcName, bool createIf, const InterfaceID &iid, void **ppSvc) const
	implementation of service method More...

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

	Algorithm (const Algorithm &a)=delete
	Private Copy constructor: NO COPY ALLOWED. More...

Algorithm &	operator= (const Algorithm &rhs)=delete
	Private 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
	Algorithm's index. More...

std::vector< Algorithm * >	m_subAlgms
	Sub algorithms. 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_auditInit {this, "AuditAlgorithms", false, "[[deprecated]] unused"}

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

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

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

Gaudi::Property< bool >	m_auditorExecute {this, "AuditExecute", false, "trigger auditor on execute()"}

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

Gaudi::Property< bool >	m_auditorBeginRun {this, "AuditBeginRun", false, "trigger auditor on beginRun()"}

Gaudi::Property< bool >	m_auditorEndRun {this, "AuditEndRun", false, "trigger auditor on endRun()"}

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_doTimeline {this, "Timeline", true, "send events to TimelineSvc"}

Gaudi::Property< std::string >	m_monitorSvcName

Gaudi::Property< bool >	m_registerContext

Gaudi::Property< int >	m_cardinality {this, "Cardinality", 1, "how many clones to create - 0 means algo is reentrant"}

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

Gaudi::Property< bool >	m_isIOBound

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

bool	m_isFinalized
	Algorithm has been finalized flag. More...

bool	m_beginRunCalled
	temporary flags to check if derived class's begin/endRun methods called More...

bool	m_endRunCalled

Additional Inherited Members
Protected Types inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
enum	CircularDepAction
	A circular dependency handling action. More...

using	DataObjIDMapping = std::function< boost::optional< DataObjID >(const DataObjID &)>
	DataObjID mapping function, with optimized identity mapping case. More...

using	CircularDepHandler = std::function< CircularDepAction(const DataObjID &)>
	A circular dependency handler, which can take any user-specified step (e.g. 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 79 of file Algorithm.h.

Member Typedef Documentation

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

Definition at line 84 of file Algorithm.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

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

Definition at line 49 of file Algorithm.cpp.

             {
     PyErr_Print();
   } else if ( PyLong_Check( c ) ) {
     sc = StatusCode( PyLong_AsLong( c ) );
   } else {
     std::string msg( " call_python_method unexpected type from '" );
     msg += method;
     msg += "().getCode()' ";
     PyErr_SetString( PyExc_TypeError, msg.c_str() );
     PyErr_Print();
   }
   // release used objects
   Py_XDECREF( c );
   Py_XDECREF( r );
   //
   return sc;
 }
 // ============================================================================
 

Algorithm::Algorithm ( const Algorithm & a )

privatedelete

Private Copy constructor: NO COPY ALLOWED.

Member Function Documentation

template<class T >

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

inline

Definition at line 466 of file Algorithm.h.

   {
     m_toolHandleArrays.push_back( &hndlArr );
   }

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

Definition at line 800 of file Algorithm.cpp.

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

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

Definition at line 801 of file Algorithm.cpp.

StatusCode Algorithm::beginRun ( )

override

Algorithm begin run.

This method is called at the beginning of the event loop.

Definition at line 457 of file Algorithm.cpp.

unsigned int Algorithm::cardinality ( ) const

inlineoverride

Return the cardinality.

Definition at line 493 of file Algorithm.h.

493 { return m_cardinality; }

Algorithm::m_cardinality

Gaudi::Property< int > m_cardinality

Definition: Algorithm.h:587

SmartIF<IChronoStatSvc>& Algorithm::chronoStatService ( ) const

inline

Definition at line 262 of file Algorithm.h.

262 { return chronoSvc(); }

Algorithm::chronoSvc

SmartIF< IChronoStatSvc > & chronoSvc() const

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

Definition: Algorithm.cpp:802

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

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

Definition at line 802 of file Algorithm.cpp.

StatusCode Algorithm::configure ( )

inlineoverride

Dummy implementation of IStateful::configure() method.

Definition at line 175 of file Algorithm.h.

175 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:87

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

get Algorithm Context Service

Definition at line 812 of file Algorithm.cpp.

StatusCode Algorithm::createSubAlgorithm	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pSubAlg
	)

Create a sub algorithm.

A call to this method creates a child algorithm object. Note that the returned pointer is to Algorithm (as opposed to IAlgorithm), and thus the methods of IProperty are also available for the direct setting of the sub-algorithm's properties. Using this mechanism instead of creating daughter algorithms directly via the new operator is prefered since then the framework may take care of all of the necessary book-keeping.

Parameters

type	The concrete algorithm class of the sub algorithm
name	The name to be given to the sub algorithm
pSubAlg	Set to point to the newly created algorithm object

Definition at line 832 of file Algorithm.cpp.

template<class T >

void 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 414 of file Algorithm.h.

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

void 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 427 of file Algorithm.h.

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

template<class T >

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

inline

Definition at line 371 of file Algorithm.h.

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

template<class T >

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

inline

Definition at line 382 of file Algorithm.h.

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

template<class T >

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

inline

Definition at line 444 of file Algorithm.h.

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

template<class T >

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

inline

Definition at line 450 of file Algorithm.h.

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

void Algorithm::deregisterTool ( IAlgTool * tool ) const

Definition at line 968 of file Algorithm.cpp.

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

The standard detector data persistency conversion service.

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

Definition at line 804 of file Algorithm.cpp.

SmartIF<IConversionSvc>& Algorithm::detDataCnvService ( ) const

inline

Definition at line 274 of file Algorithm.h.

274 { return detCnvSvc(); }

Algorithm::detCnvSvc

SmartIF< IConversionSvc > & detCnvSvc() const

The standard detector data persistency conversion service.

Definition: Algorithm.cpp:804

SmartIF<IDataProviderSvc>& Algorithm::detDataService ( ) const

inline

Definition at line 268 of file Algorithm.h.

268 { return detSvc(); }

Algorithm::detSvc

SmartIF< IDataProviderSvc > & detSvc() const

The standard detector data service.

Definition: Algorithm.cpp:803

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

The standard detector data service.

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

Definition at line 803 of file Algorithm.cpp.

StatusCode Algorithm::endRun ( )

override

Algorithm end run. This method is called at the end of the event loop.

Definition at line 521 of file Algorithm.cpp.

unsigned int Algorithm::errorCount ( ) const

Get the number of failures of the algorithm.

Definition at line 984 of file Algorithm.cpp.

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

The standard event data persistency conversion service.

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

Definition at line 806 of file Algorithm.cpp.

SmartIF<IConversionSvc>& Algorithm::eventDataCnvService ( ) const

inline

Definition at line 288 of file Algorithm.h.

   {
     return eventCnvSvc();
   }

SmartIF<IDataProviderSvc>& Algorithm::eventDataService ( ) const

inline

Definition at line 282 of file Algorithm.h.

282 { return eventSvc(); }

Algorithm::eventSvc

SmartIF< IDataProviderSvc > & eventSvc() const final override

The standard event data service.

Definition: Algorithm.cpp:805

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

finaloverride

The standard event data service.

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

Definition at line 805 of file Algorithm.cpp.

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

inline

shortcut for method eventSvc

Definition at line 281 of file Algorithm.h.

281 { return eventSvc(); }

Algorithm::eventSvc

SmartIF< IDataProviderSvc > & eventSvc() const final override

The standard event data service.

Definition: Algorithm.cpp:805

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

Get the exception Service.

Definition at line 811 of file Algorithm.cpp.

AlgExecState & Algorithm::execState ( const EventContext & ctx ) const

protected

reference to AlgExecState of Alg

Definition at line 778 of file Algorithm.cpp.

bool Algorithm::filterPassed ( ) const

override

Did this algorithm pass or fail its filter criterion for the last event?

Definition at line 771 of file Algorithm.cpp.

StatusCode Algorithm::finalize ( )

inlineoverride

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

Definition at line 186 of file Algorithm.h.

186 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:87

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

inlineoverride

returns the current state of the algorithm

Definition at line 192 of file Algorithm.h.

192 { return m_state; }

Algorithm::m_state

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:600

template<typename IFace >

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

private

Definition at line 788 of file Algorithm.cpp.

const EventContext& Algorithm::getContext ( ) const

inlineoverride

get the context

Definition at line 437 of file Algorithm.h.

437 { return Gaudi::Hive::currentContext(); }

Gaudi::Hive::currentContext

GAUDI_API const EventContext & currentContext()

Definition: ThreadLocalContext.cpp:24

SmartIF<IHistogramSvc>& Algorithm::histogramDataService ( ) const

inline

Definition at line 297 of file Algorithm.h.

297 { return histoSvc(); }

Algorithm::histoSvc

SmartIF< IHistogramSvc > & histoSvc() const

The standard histogram service.

Definition: Algorithm.cpp:807

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

The standard histogram service.

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

Definition at line 807 of file Algorithm.cpp.

unsigned int Algorithm::index ( ) const

override

Definition at line 753 of file Algorithm.cpp.

StatusCode Algorithm::initialize ( )

inlineoverride

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

Definition at line 180 of file Algorithm.h.

180 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:87

void Algorithm::initToolHandles ( ) const

private

Definition at line 853 of file Algorithm.cpp.

bool Algorithm::isEnabled ( ) const

override

Is this algorithm enabled or disabled?

Definition at line 769 of file Algorithm.cpp.

bool Algorithm::isExecuted ( ) const

override

Has this algorithm been executed since the last reset?

Definition at line 757 of file Algorithm.cpp.

bool Algorithm::isFinalized ( ) const

inlineoverrideprotected

Has the Algorithm already been finalized?

Definition at line 502 of file Algorithm.h.

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

Gaudi::StateMachine::CONFIGURED

Definition: StateMachine.h:16

Algorithm::m_state

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:600

bool Algorithm::isInitialized ( ) const

inlineoverrideprotected

Has the Algorithm already been initialized?

Definition at line 499 of file Algorithm.h.

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

Gaudi::StateMachine::INITIALIZED

Definition: StateMachine.h:17

Algorithm::m_state

Gaudi::StateMachine::State m_state

flag indicating whether ToolHandle tools have been added to m_tools

Definition: Algorithm.h:600

bool Algorithm::isIOBound ( ) const

inline

Definition at line 474 of file Algorithm.h.

474 { return m_isIOBound; }

Algorithm::m_isIOBound

Gaudi::Property< bool > m_isIOBound

Definition: Algorithm.h:591

bool Algorithm::isSequence ( ) const

inlineoverride

Are we a Sequence?

Definition at line 219 of file Algorithm.h.

219 { return false; }

unsigned int Algorithm::maxErrors ( ) const

inlineprivate

Definition at line 515 of file Algorithm.h.

515 { return m_errorMax; }

Algorithm::m_errorMax

Gaudi::Property< unsigned int > m_errorMax

Definition: Algorithm.h:566

SmartIF<IMonitorSvc>& 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 399 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;
   }

const std::string & 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 747 of file Algorithm.cpp.

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

override

Definition at line 749 of file Algorithm.cpp.

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

inlineoverride

Definition at line 495 of file Algorithm.h.

495 { return m_neededResources; }

Algorithm::m_neededResources

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

Definition: Algorithm.h:588

SmartIF<INTupleSvc>& Algorithm::ntupleService ( ) const

inline

Definition at line 303 of file Algorithm.h.

303 { return ntupleSvc(); }

Algorithm::ntupleSvc

SmartIF< INTupleSvc > & ntupleSvc() const

The standard N tuple service.

Definition: Algorithm.cpp:808

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

The standard N tuple service.

Returns a pointer to the N tuple service if present.

Definition at line 808 of file Algorithm.cpp.

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

privatedelete

Private assignment operator: NO ASSIGNMENT ALLOWED.

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

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

Definition at line 809 of file Algorithm.cpp.

bool Algorithm::registerContext ( ) const

inline

register for Algorithm Context Service?

Definition at line 335 of file Algorithm.h.

335 { return m_registerContext; }

Algorithm::m_registerContext

Gaudi::Property< bool > m_registerContext

Definition: Algorithm.h:584

void Algorithm::registerTool ( IAlgTool * tool ) const

Definition at line 960 of file Algorithm.cpp.

StatusCode Algorithm::reinitialize ( )

override

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

Definition at line 710 of file Algorithm.cpp.

void Algorithm::resetExecuted ( )

override

Reset the executed state of the Algorithm for the duration of the current event.

Definition at line 767 of file Algorithm.cpp.

StatusCode Algorithm::restart ( )

override

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

Definition at line 731 of file Algorithm.cpp.

template<class T >

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

inline

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

Definition at line 232 of file Algorithm.h.

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

template<class T >

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

inline

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

Definition at line 239 of file Algorithm.h.

   {
     return service_i( svcType, svcName, T::interfaceID(), reinterpret_cast<void**>( &psvc ) );
   }

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

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

Definition at line 954 of file Algorithm.cpp.

template<class T >

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

inline

Definition at line 248 of file Algorithm.h.

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

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

private

implementation of service method

Protected Member Functions.

Definition at line 941 of file Algorithm.cpp.

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

private

Definition at line 947 of file Algorithm.cpp.

SmartIF< ISvcLocator > & 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 816 of file Algorithm.cpp.

void Algorithm::setExecuted ( bool state ) const

override

Set the executed flag to the specified state.

Definition at line 762 of file Algorithm.cpp.

void Algorithm::setFilterPassed ( bool state ) const

override

Set the filter passed flag to the specified state.

Definition at line 773 of file Algorithm.cpp.

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

overrideprotected

set instantiation index of Alg

Definition at line 755 of file Algorithm.cpp.

void Algorithm::setIOBound ( bool value )

inline

Definition at line 476 of file Algorithm.h.

476 { m_isIOBound = value; }

Algorithm::m_isIOBound

Gaudi::Property< bool > m_isIOBound

Definition: Algorithm.h:591

StatusCode Algorithm::setProperties ( )

Set the algorithm's properties.

This method requests the job options service to set the values of any declared properties. The method is invoked from within sysInitialize() by the framework and does not need to be explicitly called by a concrete algorithm.

Definition at line 819 of file Algorithm.cpp.

void Algorithm::setType ( const std::string & type )

inlineoverride

Definition at line 168 of file Algorithm.h.

168 { m_type = type; } // BH, TODO: move to proper place

Algorithm::m_type

std::string m_type

Algorithm's type.

Definition: Algorithm.h:519

Algorithm::type

const std::string & type() const override

The type of the algorithm object.

Definition: Algorithm.h:167

StatusCode Algorithm::start ( )

inlineoverride

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

Definition at line 182 of file Algorithm.h.

182 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:87

StatusCode Algorithm::stop ( )

inlineoverride

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

Definition at line 184 of file Algorithm.h.

184 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:87

const std::vector< Algorithm * > * Algorithm::subAlgorithms ( ) const

List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms.

Definition at line 783 of file Algorithm.cpp.

std::vector< Algorithm * > * Algorithm::subAlgorithms ( )

List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms.

Definition at line 785 of file Algorithm.cpp.

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

inline

shortcut for method serviceLocator

Definition at line 328 of file Algorithm.h.

328 { return serviceLocator(); }

Algorithm::serviceLocator

SmartIF< ISvcLocator > & serviceLocator() const override

The standard service locator.

Definition: Algorithm.cpp:816

StatusCode Algorithm::sysBeginRun ( )

override

beginRun method invoked by the framework.

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

Definition at line 400 of file Algorithm.cpp.

StatusCode Algorithm::sysEndRun ( )

override

endRun method invoked by the framework.

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

Definition at line 465 of file Algorithm.cpp.

StatusCode 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 528 of file Algorithm.cpp.

StatusCode 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 659 of file Algorithm.cpp.

StatusCode 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 76 of file Algorithm.cpp.

     : Algorithm( name, Gaudi::svcLocator() ), m_self( self )
 {
   // The owner of the Algorithm is Python (as creator) therefore
   // it should not be deleted by Gaudi (added an extra addRef()).
   addRef();
   addRef();
 }
 // ============================================================================
 
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::initialize() { return GaudiPython::call_python_method( m_self, "initialize" ); }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::start() { return GaudiPython::call_python_method( m_self, "start" ); }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::execute() { return GaudiPython::call_python_method( m_self, "execute" ); }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::stop() { return GaudiPython::call_python_method( m_self, "stop" ); }
 // ============================================================================
 StatusCode GaudiPython::PyAlgorithm::finalize() { return GaudiPython::call_python_method( m_self, "finalize" ); }
 
 StatusCode GaudiPython::PyAlgorithm::beginRun() { return GaudiPython::call_python_method( m_self, "beginRun" ); }
 StatusCode GaudiPython::PyAlgorithm::endRun() { return GaudiPython::call_python_method( m_self, "endRun" ); }

StatusCode 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 289 of file Algorithm.cpp.

StatusCode 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 347 of file Algorithm.cpp.

StatusCode 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 237 of file Algorithm.cpp.

StatusCode 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 612 of file Algorithm.cpp.

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

inlineoverride

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

Definition at line 194 of file Algorithm.h.

194 { return m_targetState; }

Algorithm::m_targetState

Gaudi::StateMachine::State m_targetState

Algorithm has been initialized flag.

Definition: Algorithm.h:601

StatusCode Algorithm::terminate ( )

inlineoverride

Dummy implementation of IStateful::terminate() method.

Definition at line 177 of file Algorithm.h.

177 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition: StatusCode.h:87

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

Definition at line 813 of file Algorithm.cpp.

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

override

Produce string represention of the control flow expression.

Definition at line 979 of file Algorithm.cpp.

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

Definition at line 925 of file Algorithm.cpp.

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

protected

Definition at line 931 of file Algorithm.cpp.

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

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

Definition at line 810 of file Algorithm.cpp.

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

inlineoverride

The type of the algorithm object.

Definition at line 167 of file Algorithm.h.

167 { return m_type; }

Algorithm::m_type

std::string m_type

Algorithm's type.

Definition: Algorithm.h:519

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

override

Definition at line 751 of file Algorithm.cpp.

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

Definition at line 814 of file Algorithm.cpp.

Member Data Documentation

friend Algorithm::AlgorithmManager

Definition at line 86 of file Algorithm.h.

SmartIF<IAlgExecStateSvc> Algorithm::m_aess

mutableprivate

Alg execution state mgr.

Definition at line 550 of file Algorithm.h.

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

private

Definition at line 568 of file Algorithm.h.

Gaudi::Property<bool> Algorithm::m_auditorBeginRun {this, "AuditBeginRun", false, "trigger auditor on beginRun()"}

private

Definition at line 574 of file Algorithm.h.

Gaudi::Property<bool> Algorithm::m_auditorEndRun {this, "AuditEndRun", false, "trigger auditor on endRun()"}

private

Definition at line 575 of file Algorithm.h.

Gaudi::Property<bool> Algorithm::m_auditorExecute {this, "AuditExecute", false, "trigger auditor on execute()"}

private

Definition at line 572 of file Algorithm.h.

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

private

Definition at line 573 of file Algorithm.h.

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

private

Definition at line 569 of file Algorithm.h.

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

private

Definition at line 570 of file Algorithm.h.

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

private

Definition at line 571 of file Algorithm.h.

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

private

Definition at line 576 of file Algorithm.h.

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

private

Definition at line 577 of file Algorithm.h.

bool Algorithm::m_beginRunCalled

private

temporary flags to check if derived class's begin/endRun methods called

Definition at line 605 of file Algorithm.h.

Gaudi::Property<int> Algorithm::m_cardinality {this, "Cardinality", 1, "how many clones to create - 0 means algo is reentrant"}

private

Definition at line 587 of file Algorithm.h.

SmartIF<IAlgContextSvc> Algorithm::m_contextSvc

mutableprivate

Algorithm Context Service.

Definition at line 547 of file Algorithm.h.

SmartIF<IChronoStatSvc> Algorithm::m_CSS

mutableprivate

Chrono & Stat Service.

Definition at line 541 of file Algorithm.h.

SmartIF<IConversionSvc> Algorithm::m_DCS

mutableprivate

Detector conversion service.

Definition at line 538 of file Algorithm.h.

SmartIF<IDataProviderSvc> Algorithm::m_DDS

mutableprivate

Detector data service.

Definition at line 537 of file Algorithm.h.

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

private

Definition at line 579 of file Algorithm.h.

SmartIF<IConversionSvc> Algorithm::m_ECS

mutableprivate

Event conversion service.

Definition at line 536 of file Algorithm.h.

SmartIF<IDataProviderSvc> Algorithm::m_EDS

mutableprivate

Event data service.

Definition at line 534 of file Algorithm.h.

bool Algorithm::m_endRunCalled

private

Definition at line 606 of file Algorithm.h.

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

private

Definition at line 566 of file Algorithm.h.

SmartIF<IExceptionSvc> Algorithm::m_EXS

mutableprivate

Exception Handler Service.

Definition at line 543 of file Algorithm.h.

Gaudi::Property<bool> Algorithm::m_filterCircDeps

private

Initial value:

{this, "FilterCircularDependencies", true,

"filter out circular data dependencies"}

Definition at line 595 of file Algorithm.h.

SmartIF<IHistogramSvc> Algorithm::m_HDS

mutableprivate

Histogram data service.

Definition at line 539 of file Algorithm.h.

unsigned int Algorithm::m_index

private

Algorithm's index.

Definition at line 521 of file Algorithm.h.

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

private

Definition at line 564 of file Algorithm.h.

bool Algorithm::m_isFinalized

private

Algorithm has been finalized flag.

Definition at line 602 of file Algorithm.h.

Gaudi::Property<bool> Algorithm::m_isIOBound

private

Initial value:

{this, "IsIOBound", false,

"if the algorithm is I/O-bound (in the broad sense of Von Neumann bottleneck)"}

Definition at line 591 of file Algorithm.h.

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

private

Initial value:

{this, "MonitorService", "MonitorSvc",

"name to use for Monitor Service"}

Definition at line 581 of file Algorithm.h.

SmartIF<IMessageSvc> Algorithm::m_MS

mutableprivate

Message service.

Definition at line 533 of file Algorithm.h.

Gaudi::StringKey Algorithm::m_name

private

Algorithm's name for identification.

Definition at line 518 of file Algorithm.h.

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

private

Initial value:

{

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

Definition at line 588 of file Algorithm.h.

SmartIF<INTupleSvc> Algorithm::m_NTS

mutableprivate

N tuple service.

Definition at line 540 of file Algorithm.h.

Gaudi::Property<int> Algorithm::m_outputLevel

private

Initial value:

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

Definition at line 560 of file Algorithm.h.

SmartIF<IAuditorSvc> Algorithm::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 544 of file Algorithm.h.

SmartIF<IMonitorSvc> Algorithm::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 546 of file Algorithm.h.

SmartIF<ISvcLocator> Algorithm::m_pSvcLocator

private

Pointer to service locator service.

Definition at line 552 of file Algorithm.h.

SmartIF<IToolSvc> Algorithm::m_ptoolSvc

mutableprivate

ToolSvc Service.

Definition at line 545 of file Algorithm.h.

Gaudi::Property<bool> Algorithm::m_registerContext

private

Initial value:

{this, "RegisterForContextService", false,

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

Definition at line 584 of file Algorithm.h.

SmartIF<IRndmGenSvc> Algorithm::m_RGS

mutableprivate

Random Number Generator Service.

Definition at line 542 of file Algorithm.h.

Gaudi::StateMachine::State 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 600 of file Algorithm.h.

std::vector<Algorithm*> Algorithm::m_subAlgms

private

Sub algorithms.

Definition at line 522 of file Algorithm.h.

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

private

Algorithm has been initialized flag.

Definition at line 601 of file Algorithm.h.

SmartIF<ITimelineSvc> Algorithm::m_timelineSvc

mutableprivate

Timeline Service.

Definition at line 549 of file Algorithm.h.

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

mutableprivate

Definition at line 527 of file Algorithm.h.

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

mutableprivate

Definition at line 526 of file Algorithm.h.

bool Algorithm::m_toolHandlesInit = false

mutableprivate

Definition at line 598 of file Algorithm.h.

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

mutableprivate

Definition at line 525 of file Algorithm.h.

std::string Algorithm::m_type

private

Algorithm's type.

Definition at line 519 of file Algorithm.h.

DataObjIDMapping Algorithm::m_updateDependencies

protected

Hook for for derived classes to alter the DataObjID of dependencies.

Definition at line 556 of file Algorithm.h.

std::string Algorithm::m_version

private

Algorithm's version.

Definition at line 520 of file Algorithm.h.

SmartIF<IHiveWhiteBoard> Algorithm::m_WB

mutableprivate

Event data service (whiteboard)

Definition at line 535 of file Algorithm.h.

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

GaudiKernel/GaudiKernel/Algorithm.h
GaudiPython/src/Lib/Algorithm.cpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation