#include </builds/gaudi/Gaudi/GaudiAlg/include/GaudiAlg/GaudiSequencer.h>

Inheritance diagram for GaudiSequencer:

[legend]

Collaboration diagram for GaudiSequencer:

[legend]

Classes
class	AlgorithmEntry

Public Member Functions
StatusCode	initialize () override

StatusCode	execute (const EventContext &ctx) const override

StatusCode	sysExecute (const EventContext &ctx) override

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

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, PBASE>, U>>
	GaudiCommon (std::string name, ISvcLocator *pSvcLocator)
	Standard constructor. More...

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<AlgTool, PBASE>, U>>
	GaudiCommon (std::string type, std::string name, const IInterface *ancestor)
	Standard constructor. More...

	GaudiCommon ()=delete
	Standard constructor. More...

	GaudiCommon (const GaudiCommon &)=delete
	Standard constructor. More...

Public Member Functions inherited from GaudiCommon< Gaudi::Sequence >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, std::string_view 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, std::string_view 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, std::string_view 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, std::string_view 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, std::string_view location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

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

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

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

SmartIF< SERVICE >	svc (std::string_view 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...

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

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

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

StatusCode	Print (std::string_view 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, std::string_view message="", const StatusCode sc=StatusCode::FAILURE) const
	Assertion - throw exception if the given condition is not fulfilled. More...

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

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

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

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

StatEntity &	counter (std::string_view tag)

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 (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 (std::string type, std::string name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...

	GaudiCommon ()=delete

	GaudiCommon (const GaudiCommon &)=delete

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

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

GaudiCommon &	operator= (const GaudiCommon &)=delete

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

Public Member Functions inherited from FixTESPath< Gaudi::Sequence >
	FixTESPath (std::string name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if BASE derives from Algorithm. More...

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

StatusCode	initialize () override

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

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

Public Member Functions inherited from Gaudi::Sequence
bool	isSequence () const override final
	Are we a Sequence? 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	start () override
	System start. More...

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

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

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

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

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

void	acceptDHVisitor (IDataHandleVisitor *) const override

	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor. More...

Public Member Functions inherited from Gaudi::Algorithm
	Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
	Constructor. More...

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

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

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

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

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

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

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

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

const Gaudi::StringKey &	nameKey () const override

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

void	setType (std::string type) override

const std::string &	version () const override

unsigned int	index () const override

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SmartIF< ITimelineSvc > &	timelineSvc () const

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

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

SmartIF< IHiveWhiteBoard > &	whiteboard () const

SmartIF< IAlgExecStateSvc > &	algExecStateSvc () const

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

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

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

SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...

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

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

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

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

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

bool	isBlocking () const

void	setBlocking (bool value)

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

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

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

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

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

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

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

bool	renounceInput (const DataObjID &id) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

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

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void *	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 std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

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

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

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

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

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

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

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

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

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

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

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

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

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

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

void	membershipHandler ()
	for asynchronous changes in the list of algorithms More...

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_vetoObjs

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

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

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 Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm (const std::string &, ISvcLocator )>	Factory

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

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

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

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Public Attributes inherited from Gaudi::Algorithm
friend	AlgorithmManager

Protected Types inherited from GaudiCommon< Gaudi::Sequence >
using	base_class = FixTESPath< Gaudi::Sequence >

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

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

typedef std::map< std::string, unsigned int, std::less<> >	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< Gaudi::Sequence >
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 Gaudi::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...

bool	isReEntrant () const override

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

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

Protected Attributes inherited from GaudiCommon< Gaudi::Sequence >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...

Gaudi::Property< bool >	m_errorsPrint

Gaudi::Property< bool >	m_propsPrint

Gaudi::Property< bool >	m_typePrint

Gaudi::Property< std::string >	m_context

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

Protected Attributes inherited from Gaudi::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< Gaudi::Sequence >
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 38 of file GaudiSequencer.h.

Member Function Documentation

◆ decodeNames()

StatusCode GaudiSequencer::decodeNames ( )

private

Decode a vector of string.

Definition at line 139 of file GaudiSequencer.cpp.

                                        {
   StatusCode final = StatusCode::SUCCESS;
   m_entries.clear();
  
   //== Get the "Context" option if in the file...
  
   //= 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 ) {
       Gaudi::Algorithm* myAlg = nullptr;
       result                  = createSubAlgorithm( theType, theName, myAlg );
       if ( myAlg ) {
         // Override the default values of the special properties Context and RootInTES,
         // which will be superseded by the explicit value in options (if present).
         if ( !isDefault( context() ) && myAlg->hasProperty( "Context" ) ) {
           myAlg->setProperty( "Context", context() ).ignore();
         }
         if ( !isDefault( rootInTES() ) && myAlg->hasProperty( "RootInTES" ) ) {
           myAlg->setProperty( "RootInTES", rootInTES() ).ignore();
         }
       }
       myIAlg = myAlg; // ensure that myIAlg.isValid() from here onwards!
     } else {
       Gaudi::Algorithm* myAlg = dynamic_cast<Gaudi::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.
       Gaudi::Algorithm* myAlg = dynamic_cast<Gaudi::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 a Gaudi::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 ) {
                                          Gaudi::Algorithm* alg = e.algorithm();
                                          std::string       typ = alg->type();
                                          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;
 }

◆ execute()

StatusCode GaudiSequencer::execute ( const EventContext & ctx ) const

override

Definition at line 74 of file GaudiSequencer.cpp.

                                                                   {
  
   if ( m_measureTime ) m_timerTool->start( m_timer );
  
   if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Execute" << endmsg;
  
   StatusCode result = StatusCode::SUCCESS;
  
   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 ) {
     Gaudi::Algorithm* myAlg = entry.algorithm();
     if ( !myAlg->isEnabled() ) continue;
     if ( myAlg->execState( ctx ).state() != AlgExecState::State::Done ) {
  
       if ( m_measureTime ) m_timerTool->start( entry.timer() );
       result = myAlg->sysExecute( ctx );
       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->execState( ctx ).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;
   auto& state = execState( ctx );
   if ( !m_ignoreFilter && !m_entries.empty() ) state.setFilterPassed( m_invert ? !seqPass : seqPass );
   state.setState( AlgExecState::State::Done );
  
   if ( m_measureTime ) m_timerTool->stop( m_timer );
  
   return m_returnOK ? ( result.ignore(), StatusCode::SUCCESS ) : result;
 }

◆ GaudiCommon() [1/4]

GaudiCommon< PBASE >::GaudiCommon

delete

Standard constructor.

◆ GaudiCommon() [2/4]

GaudiCommon< PBASE >::GaudiCommon

delete

Standard constructor.

◆ GaudiCommon() [3/4]

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, PBASE>, U>>

GaudiCommon< PBASE >::GaudiCommon	(	typename U	= `PBASE`,
		typename	= `std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, PBASE>, U>`
	)

inline

Standard constructor.

Definition at line 612 of file GaudiCommon.h.

                                                           : base_class( std::move( name ), pSvcLocator ) {
     initGaudiCommonConstructor();
   }

◆ GaudiCommon() [4/4]

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<AlgTool, PBASE>, U>>

GaudiCommon< PBASE >::GaudiCommon	(	typename U	= `PBASE`,
		typename	= `std::enable_if_t<std::is_base_of_v<AlgTool, PBASE>, U>`
	)

inline

Standard constructor.

Definition at line 618 of file GaudiCommon.h.

       : base_class( std::move( type ), std::move( name ), ancestor ) {
     initGaudiCommonConstructor( this->parent() );
   }

◆ initialize()

StatusCode GaudiSequencer::initialize ( )

override

Definition at line 40 of file GaudiSequencer.cpp.

                                       {
   // Note: not calling base class initialize because we want to reimplement the loop over sub algs
   if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Initialise" << endmsg;
  
   auto 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 ).ignore();
     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;
 }

◆ membershipHandler()

void GaudiSequencer::membershipHandler ( )

private

for asynchronous changes in the list of algorithms

Definition at line 233 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();
 }

◆ sysExecute()

StatusCode GaudiSequencer::sysExecute ( const EventContext & ctx )

override

< guard/sentry

Definition at line 277 of file GaudiSequencer.cpp.

                                                                {
   StatusCode sc{ StatusCode::SUCCESS };
  
   IAlgContextSvc* algCtx = nullptr;
   if ( registerContext() ) { algCtx = contextSvc(); }
   // Lock the context
   Gaudi::Utils::AlgContext cnt( this, algCtx, ctx ); 
  
   // Do not execute if one or more of the m_vetoObjs exist in TES
   const auto it = find_if( begin( m_vetoObjs ), end( m_vetoObjs ),
                            [&]( const std::string& loc ) { return this->exist<DataObject>( evtSvc(), loc ); } );
   if ( it != end( m_vetoObjs ) ) {
     if ( msgLevel( MSG::DEBUG ) ) debug() << *it << " found, skipping event " << endmsg;
     return sc;
   }
  
   // Execute if m_requireObjs is empty
   // or if one or more of the m_requireObjs exist in TES
   bool doIt = m_requireObjs.empty() ||
               any_of( begin( m_requireObjs ), end( m_requireObjs ),
                       [&]( const std::string& loc ) { return this->exist<DataObject>( evtSvc(), loc ); } );
  
   // execute the generic method:
   if ( doIt ) sc = GaudiCommon<Gaudi::Sequence>::sysExecute( ctx );
   return sc;
 }

◆ toControlFlowExpression()

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

override

Produce string represention of the control flow expression.

Definition at line 255 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

◆ m_entries

std::vector<AlgorithmEntry> GaudiSequencer::m_entries

private

List of algorithms to process.

Definition at line 90 of file GaudiSequencer.h.

◆ m_ignoreFilter

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

private

Definition at line 84 of file GaudiSequencer.h.

◆ m_invert

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

private

Definition at line 88 of file GaudiSequencer.h.

◆ m_measureTime

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

private

Definition at line 85 of file GaudiSequencer.h.

◆ m_modeOR

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

private

Definition at line 83 of file GaudiSequencer.h.

◆ m_names

Gaudi::Property<std::vector<std::string> > GaudiSequencer::m_names

private

Initial value:

= {

this, "Members", {}, &GaudiSequencer::membershipHandler, "list of algorithms" }

Definition at line 80 of file GaudiSequencer.h.

◆ m_requireObjs

Gaudi::Property<std::vector<std::string> > GaudiSequencer::m_requireObjs

private

Initial value:

{

this, "RequireObjects", {}, "execute only if one or more of these TES objects exist" }

Definition at line 77 of file GaudiSequencer.h.

◆ m_returnOK

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

private

Definition at line 86 of file GaudiSequencer.h.

◆ m_sequential

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

private

Definition at line 82 of file GaudiSequencer.h.

◆ m_shortCircuit

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

private

Definition at line 87 of file GaudiSequencer.h.

◆ m_timer

int GaudiSequencer::m_timer

private

Timer number for the sequencer.

Definition at line 92 of file GaudiSequencer.h.

◆ m_timerTool

ISequencerTimerTool* GaudiSequencer::m_timerTool = nullptr

private

Pointer to the timer tool.

Definition at line 91 of file GaudiSequencer.h.

◆ m_vetoObjs

Gaudi::Property<std::vector<std::string> > GaudiSequencer::m_vetoObjs

private

Initial value:

{

this, "VetoObjects", {}, "skip execute if one or more of these TES objects exist" }

Definition at line 75 of file GaudiSequencer.h.

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ decodeNames()

◆ execute()

◆ GaudiCommon() [1/4]

◆ GaudiCommon() [2/4]

◆ GaudiCommon() [3/4]

◆ GaudiCommon() [4/4]

◆ initialize()

◆ membershipHandler()

◆ sysExecute()

◆ toControlFlowExpression()

Member Data Documentation

◆ m_entries

◆ m_ignoreFilter

◆ m_invert

◆ m_measureTime

◆ m_modeOR

◆ m_names

◆ m_requireObjs

◆ m_returnOK

◆ m_sequential

◆ m_shortCircuit

◆ m_timer

◆ m_timerTool

◆ m_vetoObjs