Sequencer for executing several algorithms, stopping when one is faulty. More...

#include <GaudiAlg/GaudiSequencer.h>

Inheritance diagram for GaudiSequencer:

[legend]

Collaboration diagram for GaudiSequencer:

[legend]

Classes
class	AlgorithmEntry

Public Member Functions
	GaudiSequencer (const std::string &name, ISvcLocator *pSvcLocator)
	Standard constructor. More...

StatusCode	initialize () override
	Algorithm initialization. More...

StatusCode	execute () override
	Algorithm execution. More...

bool	isSequence () const override final

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

Public Member Functions inherited from GaudiAlgorithm
StatusCode	initialize () override
	standard initialization method More...

StatusCode	execute () override
	standard execution method More...

StatusCode	finalize () override
	standard finalization method More...

StatusCode	sysExecute (const EventContext &ctx) override
	the generic actions for the execution. More...

void	put (IDataProviderSvc svc, DataObject object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

void	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const

const DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

const DataObject *	put (std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

template<class TYPE >
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

template<class TYPE >
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...

template<class TYPE >
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...

template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

	GaudiAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Standard constructor. More...

	GaudiAlgorithm (const GaudiAlgorithm &)=delete

GaudiAlgorithm &	operator= (const GaudiAlgorithm &)=delete

SmartIF< INTupleSvc > &	evtColSvc () const
	Access the standard event collection service. More...

Public Member Functions inherited from GaudiCommon< Algorithm >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Quicker version of the get function which bypasses the check on the retrieved data. More...

bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

DataObject *	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

DataObject *	put (IDataProviderSvc svc, DataObject object, const std::string &location, const bool useRootInTES=true) const

TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...

TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...

SmartIF< SERVICE >	svc (const std::string &name, const bool create=true) const
	A useful method for the easy location of services. More...

IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service. More...

WARN_UNUSED StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...

WARN_UNUSED StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...

WARN_UNUSED StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...

WARN_UNUSED StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode. More...

void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...

void	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...

void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...

void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...

void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...

const Statistics	counters () const
	accessor to all counters More...

StatEntity &	counter (const std::string &tag) const
	accessor to certain counter by name More...

StatEntity &	counter (const std::string &tag)

void	registerCounter (const std::string &tag, Gaudi::Accumulators::PrintableCounter &r)

bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ? More...

bool	propsPrint () const
	Print properties at initialization ? More...

bool	statPrint () const
	Print statistical counters at finalization ? More...

bool	errorsPrint () const
	Print error counters at finalization ? More...

long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters More...

long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters More...

long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties More...

void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=nullptr)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

void	registerCondition (const std::string &condition, CondType &condPtrDest, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

void	registerCondition (char condition, StatusCode(CallerClass::mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...

void	registerCondition (TargetClass condition, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident. More...

	GaudiCommon (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from Algorithm. More...

	GaudiCommon (const std::string &type, const std::string &name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...

StatusCode	initialize () override
	standard initialization method More...

StatusCode	finalize () override
	standard finalization method More...

StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service. More...

const Services &	services () const
	get the list of aquired services More...

const std::string &	context () const
	Returns the "context" string. Used to identify different processing states. More...

const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...

const std::string	fullTESLocation (const std::string &location, const bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...

Public Member Functions inherited from Algorithm
	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
	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	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, 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 > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

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

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

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

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

Private Member Functions
StatusCode	decodeNames ()
	Decode a vector of string. More...

void	membershipHandler (Gaudi::Details::PropertyBase &theProp)
	for asynchronous changes in the list of algorithms More...

	GaudiSequencer (const GaudiSequencer &a)=delete
	copy/assignment not allowed More...

GaudiSequencer &	operator= (const GaudiSequencer &a)=delete

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_names = {this, "Members", {}, "list of algorithms"}

Gaudi::Property< bool >	m_sequential = {this, "Sequential", false, "execute members one at a time"}

Gaudi::Property< bool >	m_modeOR = {this, "ModeOR", false, "use OR logic instead of AND"}

Gaudi::Property< bool >	m_ignoreFilter = {this, "IgnoreFilterPassed", false, "always continue"}

Gaudi::Property< bool >	m_measureTime = {this, "MeasureTime", false, "measure time"}

Gaudi::Property< bool >	m_returnOK = {this, "ReturnOK", false, "forces the sequencer to return a good status"}

Gaudi::Property< bool >	m_shortCircuit = {this, "ShortCircuit", true, "stop processing as soon as possible"}

Gaudi::Property< bool >	m_invert = {this, "Invert", false, "invert the logic result of the sequencer"}

std::vector< AlgorithmEntry >	m_entries
	List of algorithms to process. More...

ISequencerTimerTool *	m_timerTool = nullptr
	Pointer to the timer tool. More...

int	m_timer
	Timer number for the sequencer. More...

Additional Inherited Members
Public Types inherited from Algorithm
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 Attributes inherited from Algorithm
friend	AlgorithmManager

Protected Types inherited from GaudiCommon< Algorithm >
using	base_class = Algorithm

typedef std::map< std::string, StatEntity >	StatisticsOwn
	the actual type of general counters More...

typedef std::map< std::string, std::reference_wrapper< Gaudi::Accumulators::PrintableCounter > >	Statistics

typedef std::map< std::string, unsigned int >	Counter
	the actual type error/warning counter More...

typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools More...

typedef std::vector< SmartIF< IService > >	Services
	storage for active services More...

Protected Member Functions inherited from GaudiCommon< Algorithm >
StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool More...

StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service More...

Protected Member Functions inherited from Algorithm
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	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this 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 inherited from GaudiCommon< Algorithm >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...

Protected Attributes inherited from Algorithm
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

Static Protected Attributes inherited from GaudiCommon< Algorithm >
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Detailed Description

Sequencer for executing several algorithms, stopping when one is faulty.

Default behaviour (ModeOR=False) is to execute all algorithms until one returns filterPassed() = False. If ShortCircuit is set to False, then all algorithms will be executed.

In OR mode, the logic is opposite. All algorithms until one returns filterPassed() = True. To then exit one must conter-intuitively set ShortCircuit to False. If the default value ShortCircuit=True is left then all algorithms will be executed.

Author: Olivier Callot

Date: 2004-05-13

Definition at line 26 of file GaudiSequencer.h.

Constructor & Destructor Documentation

GaudiSequencer::GaudiSequencer	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Standard constructor.

Definition at line 76 of file GaudiSequencer.cpp.

     : GaudiAlgorithm( name, pSvcLocator )
 {
   m_names.declareUpdateHandler( &GaudiSequencer::membershipHandler, this );
 }

GaudiSequencer::GaudiSequencer ( const GaudiSequencer & a )

privatedelete

copy/assignment not allowed

Member Function Documentation

StatusCode GaudiSequencer::decodeNames ( )

private

Decode a vector of string.

Definition at line 188 of file GaudiSequencer.cpp.

 {
   StatusCode final = StatusCode::SUCCESS;
   m_entries.clear();
 
   //== Get the "Context" option if in the file...
   auto jos = service<IJobOptionsSvc>( "JobOptionsSvc" );
 
   //= Get the Application manager, to see if algorithm exist
   auto appMgr = service<IAlgManager>( "ApplicationMgr" );
   for ( const auto& item : m_names.value() ) {
     const Gaudi::Utils::TypeNameString typeName( item );
     const std::string&                 theName = typeName.name();
     const std::string&                 theType = typeName.type();
 
     //== Check wether the specified algorithm already exists. If not, create it
     StatusCode          result = StatusCode::SUCCESS;
     SmartIF<IAlgorithm> myIAlg = appMgr->algorithm( typeName, false ); // do not create it now
     if ( !myIAlg ) {
       // ensure some magic properties are set while we create the subalgorithm so
       // that it effectively inherites 'our' settings -- if they have non-default
       // values... and are not set explicitly already.
       populate_JobOptionsSvc_t populate_guard{theName, jos, std::forward_as_tuple( "Context", context() ),
                                               std::forward_as_tuple( "RootInTES", rootInTES() )};
       Algorithm* myAlg = nullptr;
       result           = createSubAlgorithm( theType, theName, myAlg );
       myIAlg           = myAlg; // ensure that myIAlg.isValid() from here onwards!
     } else {
       Algorithm* myAlg = dynamic_cast<Algorithm*>( myIAlg.get() );
       if ( myAlg ) {
         subAlgorithms()->push_back( myAlg );
         // when the algorithm is not created, the ref count is short by one, so we have to fix it.
         myAlg->addRef();
       }
     }
 
     // propagate the sub-algorithm into own state.
     if ( result.isSuccess() && Gaudi::StateMachine::INITIALIZED <= FSMState() && myIAlg &&
          Gaudi::StateMachine::INITIALIZED > myIAlg->FSMState() ) {
       StatusCode sc                = myIAlg->sysInitialize();
       if ( sc.isFailure() ) result = sc;
     }
 
     // propagate the sub-algorithm into own state.
     if ( result.isSuccess() && Gaudi::StateMachine::RUNNING <= FSMState() && myIAlg &&
          Gaudi::StateMachine::RUNNING > myIAlg->FSMState() ) {
       StatusCode sc                = myIAlg->sysStart();
       if ( sc.isFailure() ) result = sc;
     }
 
     //== Is it an Algorithm ?  Strange test...
     if ( result.isSuccess() ) {
       // TODO: (MCl) it is possible to avoid the dynamic_cast in most of the
       //             cases by keeping the result of createSubAlgorithm.
       Algorithm* myAlg = dynamic_cast<Algorithm*>( myIAlg.get() );
       if ( myAlg ) {
         // Note: The reference counting is kept by the system of sub-algorithms
         m_entries.emplace_back( myAlg );
         if ( msgLevel( MSG::DEBUG ) ) debug() << "Added algorithm " << theName << endmsg;
       } else {
         warning() << theName << " is not an Algorithm - failed dynamic_cast" << endmsg;
         final = StatusCode::FAILURE;
       }
     } else {
       warning() << "Unable to find or create " << theName << endmsg;
       final = result;
     }
   }
 
   //== Print the list of algorithms
   MsgStream& msg = info();
   if ( m_modeOR ) msg << "OR ";
   msg << "Member list: ";
   GaudiUtils::details::ostream_joiner( msg, m_entries, ", ",
                                        []( auto& os, const AlgorithmEntry& e ) -> decltype( auto ) {
                                          Algorithm*  alg = e.algorithm();
                                          std::string typ = System::typeinfoName( typeid( *alg ) );
                                          os << typ;
                                          if ( alg->name() != typ ) os << "/" << alg->name();
                                          return os;
                                        } );
   if ( !isDefault( context() ) ) msg << ", with context '" << context() << "'";
   if ( !isDefault( rootInTES() ) ) msg << ", with rootInTES '" << rootInTES() << "'";
   msg << endmsg;
 
   return final;
 }

StatusCode GaudiSequencer::execute ( )

override

Algorithm execution.

Definition at line 123 of file GaudiSequencer.cpp.

 {
 
   if ( m_measureTime ) m_timerTool->start( m_timer );
 
   if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Execute" << endmsg;
 
   StatusCode result = StatusCode( StatusCode::SUCCESS, true );
 
   bool seqPass = !m_modeOR; //  for OR, result will be false, unless (at least) one is true
                             //  for AND, result will be true, unless (at least) one is false
                             //    also see comment below ....
 
   for ( auto& entry : m_entries ) {
     Algorithm* myAlg = entry.algorithm();
     if ( !myAlg->isEnabled() ) continue;
     if ( !myAlg->isExecuted() ) {
 
       if ( m_measureTime ) m_timerTool->start( entry.timer() );
       result = myAlg->sysExecute( getContext() );
       if ( m_measureTime ) m_timerTool->stop( entry.timer() );
       if ( !result.isSuccess() ) break; //== Abort and return bad status
     }
     //== Check the returned status
     if ( !m_ignoreFilter ) {
       bool passed = myAlg->filterPassed();
       if ( msgLevel( MSG::VERBOSE ) )
         verbose() << "Algorithm " << myAlg->name() << " returned filter passed " << ( passed ? "true" : "false" )
                   << endmsg;
       if ( entry.reverse() ) passed = !passed;
 
       //== indicate our own result. For OR, exit as soon as true.
       //        If no more, will exit with false.
       //== for AND, exit as soon as false. Else, will be true (default)
 
       // if not short-circuiting, make sure we latch iPass to 'true' in
       // OR mode (i.e. it is sufficient for one item to be true in order
       // to be true at the end, and thus we start out at 'false'), and latch
       // to 'false' in AND mode (i.e. it is sufficient for one item to
       // be false to the false in the end, and thus we start out at 'true')
       // -- i.e. we should not just blindly return the 'last' passed status!
 
       // or to put it another way: in OR mode, we don't care about things
       // which are false, as they leave our current state alone (provided
       // we stared as 'false'!), and in AND mode, we keep our current
       // state until someone returns 'false' (provided we started as 'true')
       if ( m_modeOR ? passed : !passed ) {
         seqPass = passed;
         if ( msgLevel( MSG::VERBOSE ) ) verbose() << "SeqPass is now " << ( seqPass ? "true" : "false" ) << endmsg;
         if ( m_shortCircuit ) break;
       }
     }
   }
   if ( msgLevel( MSG::VERBOSE ) ) verbose() << "SeqPass is " << ( seqPass ? "true" : "false" ) << endmsg;
   if ( !m_ignoreFilter && !m_entries.empty() ) setFilterPassed( m_invert ? !seqPass : seqPass );
   setExecuted( true );
 
   if ( m_measureTime ) m_timerTool->stop( m_timer );
 
   return m_returnOK ? ( result.ignore(), StatusCode::SUCCESS ) : result;
 }

StatusCode GaudiSequencer::initialize ( )

override

Algorithm initialization.

Definition at line 84 of file GaudiSequencer.cpp.

 {
   GaudiAlgorithm::initialize();
 
   if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Initialise" << endmsg;
 
   StatusCode status = decodeNames();
   if ( !status.isSuccess() ) return status;
 
   m_timerTool                                      = tool<ISequencerTimerTool>( "SequencerTimerTool" );
   if ( m_timerTool->globalTiming() ) m_measureTime = true;
 
   if ( m_measureTime ) {
     m_timer = m_timerTool->addTimer( name() );
     m_timerTool->increaseIndent();
   } else {
     release( m_timerTool );
     m_timerTool = nullptr;
   }
 
   //== Initialize the algorithms
   for ( auto& entry : m_entries ) {
     if ( m_measureTime ) {
       entry.setTimer( m_timerTool->addTimer( entry.algorithm()->name() ) );
     }
 
     status = entry.algorithm()->sysInitialize();
     if ( !status.isSuccess() ) {
       return Error( "Can not initialize " + entry.algorithm()->name(), status );
     }
   }
   if ( m_measureTime ) m_timerTool->decreaseIndent();
 
   return StatusCode::SUCCESS;
 }

bool GaudiSequencer::isSequence ( ) const

inlinefinaloverride

Definition at line 35 of file GaudiSequencer.h.

35 { return true; }

void GaudiSequencer::membershipHandler ( Gaudi::Details::PropertyBase & theProp )

private

for asynchronous changes in the list of algorithms

Definition at line 279 of file GaudiSequencer.cpp.

 {
   // no action for not-yet initialized sequencer
   if ( Gaudi::StateMachine::INITIALIZED > FSMState() ) return; // RETURN
 
   decodeNames().ignore();
 
   if ( !m_measureTime ) return; // RETURN
 
   // add the entries into timer table:
 
   if ( !m_timerTool ) {
     m_timerTool = tool<ISequencerTimerTool>( "SequencerTimerTool" );
   }
 
   if ( m_timerTool->globalTiming() ) m_measureTime = true;
 
   m_timer = m_timerTool->addTimer( name() );
   m_timerTool->increaseIndent();
 
   for ( auto& entry : m_entries ) {
     entry.setTimer( m_timerTool->addTimer( entry.algorithm()->name() ) );
   }
 
   m_timerTool->decreaseIndent();
 }

GaudiSequencer& GaudiSequencer::operator= ( const GaudiSequencer & a )

privatedelete

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

override

Produce string represention of the control flow expression.

Definition at line 306 of file GaudiSequencer.cpp.

 {
   if ( m_invert ) os << "~";
   // the default filterpass value for an empty sequencer depends on ModeOR
   if ( m_entries.empty() ) return os << ( ( !m_modeOR ) ? "CFTrue" : "CFFalse" );
 
   // if we have only one element, we do not need a name
   if ( m_entries.size() > 1 ) os << "seq(";
 
   const auto op    = m_modeOR ? " | " : " & ";
   const auto last  = end( m_entries );
   const auto first = begin( m_entries );
   for ( auto iterator = first; iterator != last; ++iterator ) {
     if ( iterator != first ) os << op;
     if ( iterator->reverse() ) os << "~";
     iterator->algorithm()->toControlFlowExpression( os );
   }
 
   if ( m_entries.size() > 1 ) os << ")";
   return os;
 }

Member Data Documentation

std::vector<AlgorithmEntry> GaudiSequencer::m_entries

private

List of algorithms to process.

Definition at line 79 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_ignoreFilter = {this, "IgnoreFilterPassed", false, "always continue"}

private

Definition at line 73 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_invert = {this, "Invert", false, "invert the logic result of the sequencer"}

private

Definition at line 77 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_measureTime = {this, "MeasureTime", false, "measure time"}

private

Definition at line 74 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_modeOR = {this, "ModeOR", false, "use OR logic instead of AND"}

private

Definition at line 72 of file GaudiSequencer.h.

Gaudi::Property<std::vector<std::string> > GaudiSequencer::m_names = {this, "Members", {}, "list of algorithms"}

private

Definition at line 70 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_returnOK = {this, "ReturnOK", false, "forces the sequencer to return a good status"}

private

Definition at line 75 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_sequential = {this, "Sequential", false, "execute members one at a time"}

private

Definition at line 71 of file GaudiSequencer.h.

Gaudi::Property<bool> GaudiSequencer::m_shortCircuit = {this, "ShortCircuit", true, "stop processing as soon as possible"}

private

Definition at line 76 of file GaudiSequencer.h.

int GaudiSequencer::m_timer

private

Timer number for the sequencer.

Definition at line 81 of file GaudiSequencer.h.

ISequencerTimerTool* GaudiSequencer::m_timerTool = nullptr

private

Pointer to the timer tool.

Definition at line 80 of file GaudiSequencer.h.

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

GaudiAlg/GaudiAlg/GaudiSequencer.h
GaudiAlg/src/lib/GaudiSequencer.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation