#include <GaudiAlg/Sequencer.h>

Inheritance diagram for Sequencer:

[legend]

Collaboration diagram for Sequencer:

[legend]

Public Member Functions
	Sequencer (const std::string &name, ISvcLocator *svcloc)
	Constructor(s) More...

	~Sequencer () override=default
	Destructor. More...

StatusCode	initialize () override
	Initialization of a sequencer. More...

StatusCode	reinitialize () override
	Sequencer Reinitialization. More...

StatusCode	start () override
	Sequencer finalization. More...

StatusCode	execute () override
	The actions to be performed by the sequencer on an event. More...

StatusCode	stop () override
	Sequencer finalization. More...

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

StatusCode	beginRun () override
	Sequencer beginRun. More...

StatusCode	endRun () override
	Sequencer endRun. More...

void	resetExecuted () override
	Reset the Sequencer executed state for the current event. More...

bool	isSequence () const override final
	additional interface methods More...

virtual bool	branchFilterPassed () const
	Was the branch filter passed for the last event? More...

virtual StatusCode	setBranchFilterPassed (bool state)
	Set the branch filter passed flag for the last event. More...

virtual bool	isStopOverride () const
	Has the StopOverride mode been set? More...

StatusCode	append (Algorithm *pAlgorithm)
	Append an algorithm to the sequencer. More...

StatusCode	appendToBranch (Algorithm *pAlgorithm)
	Append an algorithm to the sequencer branch. More...

StatusCode	createAndAppend (const std::string &type, const std::string &name, Algorithm *&pAlgorithm)
	Create a algorithm and append it to the sequencer. More...

StatusCode	createAndAppendToBranch (const std::string &type, const std::string &name, Algorithm *&pAlgorithm)
	Create a algorithm and append it to the sequencer branch. More...

StatusCode	remove (Algorithm *pAlgorithm)
	Remove the specified algorithm from the sequencer. More...

StatusCode	remove (const std::string &name)

StatusCode	removeFromBranch (Algorithm *pAlgorithm)

StatusCode	removeFromBranch (const std::string &name)

const std::vector< Algorithm * > &	branchAlgorithms () const
	List of branch algorithms. More...

std::vector< Algorithm * > &	branchAlgorithms ()

StatusCode	decodeMemberNames ()
	Decode Member Name list. More...

StatusCode	decodeBranchMemberNames ()
	Decode branch member name list. More...

std::ostream &	toControlFlowExpression (std::ostream &os) const override
	Produce string represention of the control flow expression. 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...

virtual void	acceptDHVisitor (IDataHandleVisitor *) const override

void	commitHandles () override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

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

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
	PropertyHolder ()=default

	~PropertyHolder () override=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, TYPE &value, const std::string &doc="none") const

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
	Specializations for various GaudiHandles. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")

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

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

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

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

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

Public Member Functions inherited from extend_interfaces< Interfaces... >
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
StatusCode	append (Algorithm pAlgorithm, std::vector< Algorithm > &theAlgs)
	Append an algorithm to the sequencer. More...

StatusCode	createAndAppend (const std::string &type, const std::string &name, Algorithm &pAlgorithm, std::vector< Algorithm > &theAlgs)
	Create a algorithm and append it to the sequencer. More...

StatusCode	decodeNames (Gaudi::Property< std::vector< std::string >> &theNames, std::vector< Algorithm * > &theAlgs, std::vector< bool > &theLogic)
	Decode algorithm names, creating or appending algorithms as appropriate. More...

StatusCode	execute (const std::vector< Algorithm * > &theAlgs, std::vector< bool > &theLogic, Algorithm *&lastAlgorithm, unsigned int first=0)
	Execute the members in the specified list. More...

StatusCode	executeMember (Algorithm *theAlgorithm)
	Execute member algorithm. More...

StatusCode	remove (const std::string &algname, std::vector< Algorithm * > &theAlgs)
	Remove the specified algorithm from the sequencer. More...

	Sequencer (const Sequencer &a)=delete

Sequencer &	operator= (const Sequencer &rhs)=delete

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

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 > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_names {this, "Members", {}, "member names"}

Gaudi::Property< std::vector< std::string > >	m_branchNames {this, "BranchMembers", {}, "branch member names"}

Gaudi::Property< bool >	m_stopOverride {this, "StopOverride", false, "stop on filter failure override"}

std::vector< bool >	m_isInverted

std::vector< Algorithm * >	m_branchAlgs

std::vector< bool >	m_isBranchInverted

bool	m_branchFilterPassed = false

Additional Inherited Members
Public Types inherited from 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...

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

Detailed Description

ClassName: Sequencer.

Description: A Sequencer is essentially a list of Algorithms and is responsible for their management. Note that Sequences may themselves contain other Sequences. The default execute( ) implementation loops over the members of the sequence, calling their execute( ) methods. However, this can be modified if a member is disabled, has already been executed, or a member indicates that it's filter fails. The the former two cases the execution of the member is bypassed. In the latter case, the loop is terminated and the Sequencer assumes the same filtered state as the last member.

Definition at line 23 of file Sequencer.h.

Constructor & Destructor Documentation

Sequencer::Sequencer	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor(s)

Definition at line 20 of file Sequencer.cpp.

                                                                       : Algorithm( name, pSvcLocator )
 {
   // Associate action handlers with the "Members" and "BranchMembers" properties
   m_names.declareUpdateHandler( [this]( Gaudi::Details::PropertyBase& ) {
     if ( isInitialized() ) decodeMemberNames().ignore();
   } );
   m_branchNames.declareUpdateHandler( [this]( Gaudi::Details::PropertyBase& ) {
     if ( isInitialized() ) decodeBranchMemberNames().ignore();
   } );
 }

Sequencer::~Sequencer ( )

overridedefault

Destructor.

Sequencer::Sequencer ( const Sequencer & a )

protecteddelete

Member Function Documentation

StatusCode Sequencer::append ( Algorithm * pAlgorithm )

Append an algorithm to the sequencer.

Definition at line 294 of file Sequencer.cpp.

294 { return append( pAlgorithm, *subAlgorithms() ); }

Sequencer::append

StatusCode append(Algorithm *pAlgorithm)

Append an algorithm to the sequencer.

Definition: Sequencer.cpp:294

Algorithm::subAlgorithms

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

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

Definition: Algorithm.cpp:776

StatusCode Sequencer::append	(	Algorithm *	pAlgorithm,
		std::vector< Algorithm * > &	theAlgs
	)

protected

Append an algorithm to the sequencer.

Protected Member Functions.

Definition at line 337 of file Sequencer.cpp.

 {
   // Check that the specified algorithm doesn't already exist in the membership list
   if ( std::find( std::begin( theAlgs ), std::end( theAlgs ), pAlgorithm ) != std::end( theAlgs ) ) {
     return StatusCode::FAILURE;
   }
   theAlgs.push_back( pAlgorithm );
   pAlgorithm->addRef();
   return StatusCode::SUCCESS;
 }

StatusCode Sequencer::appendToBranch ( Algorithm * pAlgorithm )

Append an algorithm to the sequencer branch.

Definition at line 296 of file Sequencer.cpp.

296 { return append( pAlgorithm, branchAlgorithms() ); }

Sequencer::append

StatusCode append(Algorithm *pAlgorithm)

Append an algorithm to the sequencer.

Definition: Sequencer.cpp:294

Sequencer::branchAlgorithms

const std::vector< Algorithm * > & branchAlgorithms() const

List of branch algorithms.

Definition: Sequencer.cpp:317

StatusCode Sequencer::beginRun ( )

override

Sequencer beginRun.

Definition at line 189 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::SUCCESS;
 
   // Bypass the loop if this sequencer is disabled
   if ( isEnabled() ) {
 
     // Loop over all members calling their sysInitialize functions
     // if they are not disabled. Note that the Algoriithm::sysInitialize
     // function protects this from affecting Algorithms that have already
     // been initialized.
     for ( auto& alg : *subAlgorithms() ) {
       result = alg->sysInitialize();
       if ( result.isFailure() ) {
         error() << "Unable to initialize Algorithm " << alg->name() << endmsg;
         break;
       }
       result = alg->sysStart();
       if ( result.isFailure() ) {
         error() << "Unable to start Algorithm " << alg->name() << endmsg;
         break;
       }
     }
 
     // Loop over all members calling their beginRun functions
     // if they are not disabled.
     for ( auto& alg : *subAlgorithms() ) {
       if ( !alg->isEnabled() ) {
         alg->beginRun().ignore();
       }
     }
 
     // Loop over all branch members calling their sysInitialize functions
     // if they are not disabled. Note that the Algoriithm::sysInitialize
     // function protects this from affecting Algorithms that have already
     // been initialized.
     for ( auto& alg : branchAlgorithms() ) {
       result = alg->sysInitialize();
       if ( result.isFailure() ) {
         error() << "Unable to initialize Algorithm " << alg->name() << endmsg;
         break;
       }
       result = alg->sysStart();
       if ( result.isFailure() ) {
         error() << "Unable to start Algorithm " << alg->name() << endmsg;
         break;
       }
     }
 
     // Loop over all branch members calling their beginRun functions
     // if they are not disabled.
     for ( auto& alg : branchAlgorithms() ) {
       if ( !alg->isEnabled() ) {
         alg->beginRun().ignore();
       }
     }
   }
   return StatusCode::SUCCESS;
 }

const std::vector< Algorithm * > & Sequencer::branchAlgorithms ( ) const

List of branch algorithms.

These are the algorithms that would get executed if a filter algorithm indicated a failure. The branch is located within the main sequence by the first element, which is the filter algorithm.

Definition at line 317 of file Sequencer.cpp.

317 { return m_branchAlgs; }

Sequencer::m_branchAlgs

std::vector< Algorithm * > m_branchAlgs

Definition: Sequencer.h:237

std::vector< Algorithm * > & Sequencer::branchAlgorithms ( )

Definition at line 319 of file Sequencer.cpp.

319 { return m_branchAlgs; }

Sequencer::m_branchAlgs

std::vector< Algorithm * > m_branchAlgs

Definition: Sequencer.h:237

bool Sequencer::branchFilterPassed ( ) const

virtual

Was the branch filter passed for the last event?

Definition at line 284 of file Sequencer.cpp.

284 { return m_branchFilterPassed; }

Sequencer::m_branchFilterPassed

bool m_branchFilterPassed

Definition: Sequencer.h:240

StatusCode Sequencer::createAndAppend	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pAlgorithm
	)

Create a algorithm and append it to the sequencer.

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 algorithm's properties. Using this mechanism instead of creating algorithms directly via the new operator is preferred since then the framework may take care of all of the necessary book-keeping.

Definition at line 298 of file Sequencer.cpp.

 {
   return createAndAppend( type, name, pAlgorithm, *subAlgorithms() );
 }

StatusCode Sequencer::createAndAppend	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pAlgorithm,
		std::vector< Algorithm * > &	theAlgs
	)

protected

Create a algorithm and append it to the sequencer.

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 algorithm's properties. Using this mechanism instead of creating algorithms directly via the new operator is preferred since then the framework may take care of all of the necessary book-keeping.

Definition at line 348 of file Sequencer.cpp.

 {
   auto theAlgMgr = serviceLocator()->service<IAlgManager>( "ApplicationMgr" );
   if ( !theAlgMgr ) return StatusCode::FAILURE;
 
   IAlgorithm* tmp;
   StatusCode result = theAlgMgr->createAlgorithm( type, algName, tmp );
   if ( result.isSuccess() ) {
     try {
       pAlgorithm = dynamic_cast<Algorithm*>( tmp );
       theAlgs.push_back( pAlgorithm );
     } catch ( ... ) {
       error() << "Unable to create Algorithm " << algName << endmsg;
       result = StatusCode::FAILURE;
     }
   }
 
   return result;
 }

StatusCode Sequencer::createAndAppendToBranch	(	const std::string &	type,
		const std::string &	name,
		Algorithm *&	pAlgorithm
	)

Create a algorithm and append it to the sequencer branch.

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 algorithm's properties. Using this mechanism instead of creating algorithms directly via the new operator is preferred since then the framework may take care of all of the necessary book-keeping.

Definition at line 303 of file Sequencer.cpp.

 {
   return createAndAppend( type, name, pAlgorithm, branchAlgorithms() );
 }

StatusCode Sequencer::decodeBranchMemberNames ( )

Decode branch member name list.

Definition at line 327 of file Sequencer.cpp.

 {
   // Decode the branch membership list
   return decodeNames( m_branchNames, branchAlgorithms(), m_isBranchInverted );
 }

StatusCode Sequencer::decodeMemberNames ( )

Decode Member Name list.

Definition at line 321 of file Sequencer.cpp.

 {
   // Decode the membership list
   return decodeNames( m_names, *subAlgorithms(), m_isInverted );
 }

StatusCode Sequencer::decodeNames	(	Gaudi::Property< std::vector< std::string >> &	theNames,
		std::vector< Algorithm * > &	theAlgs,
		std::vector< bool > &	theLogic
	)

protected

Decode algorithm names, creating or appending algorithms as appropriate.

Definition at line 369 of file Sequencer.cpp.

 {
   StatusCode result;
   auto theAlgMgr = serviceLocator()->service<IAlgManager>( "ApplicationMgr" );
   if ( theAlgMgr ) {
     // Clear the existing list of algorithms
     theAlgs.clear();
 
     // Build the list of member algorithms from the contents of the
     // theNames list.
     for ( const auto& n : theNames.value() ) {
 
       // Parse the name for a syntax of the form:
       //
       // <type>/<name>
       //
       // Where <name> is the algorithm instance name, and <type> is the
       // algorithm class type (being a subclass of Algorithm).
       const Gaudi::Utils::TypeNameString typeName( n );
       std::string theName = typeName.name();
       std::string theType = typeName.type();
 
       // Parse the name for a syntax of the form:
       //
       // <name>:invert
       //
       // Where <name> is the algorithm instance name and ":invert"
       // indicates that the filter passed logic is inverted.
       bool isInverted               = false;
       std::string::size_type invert = theName.find_first_of( ":" );
       // Skip all occurrences of "::" (allow namespaces)
       while ( std::string::npos != invert && invert < ( theName.size() - 1 ) && theName[invert + 1] == ':' )
         invert = theName.find_first_of( ":", invert + 2 );
       if ( std::string::npos != invert ) {
         if ( theName == theType ) {
           // This means that we got something like "Type:invert",
           // so we have to strip the ":invert" from the type too.
           theType = theType.substr( 0, invert );
         }
         theName    = theName.substr( 0, invert );
         isInverted = true;
       }
       // Check whether the supplied name corresponds to an existing
       // Algorithm object.
       SmartIF<IAlgorithm>& theIAlg = theAlgMgr->algorithm( theName, false );
       Algorithm* theAlgorithm      = nullptr;
       StatusCode status            = StatusCode::SUCCESS;
       if ( theIAlg ) {
         try {
           theAlgorithm = dynamic_cast<Algorithm*>( theIAlg.get() );
         } catch ( ... ) {
           warning() << theName << " is not an Algorithm - Failed dynamic cast" << endmsg;
           theAlgorithm = nullptr; // release
         }
       }
       if ( theAlgorithm ) {
 
         // The specified Algorithm already exists - just append it to the membership list.
         status = append( theAlgorithm, theAlgs );
         if ( status.isSuccess() ) {
           ON_DEBUG debug() << theName << " already exists - appended to member list" << endmsg;
         } else {
           warning() << theName << " already exists - append failed!!!" << endmsg;
           result = StatusCode::FAILURE;
         }
       } else {
 
         // The specified name doesn't exist - create a new object of the specified type
         // and append it to the membership list.
         status = createAndAppend( theType, theName, theAlgorithm, theAlgs );
         if ( status.isSuccess() ) {
           ON_DEBUG debug() << theName << " doesn't exist - created and appended to member list" << endmsg;
         } else {
           warning() << theName << " doesn't exist - creation failed!!!" << endmsg;
           result = StatusCode::FAILURE;
         }
       }
       if ( status.isSuccess() ) theLogic.push_back( isInverted );
     }
   }
   // Print membership list
   if ( result.isSuccess() && theAlgs.size() != 0 ) {
     info() << "Member list: ";
     auto ai = theAlgs.begin();
     auto li = theLogic.begin();
     for ( ; ai != theAlgs.end(); ++ai, ++li ) {
 
       if ( ai != theAlgs.begin() ) info() << ", ";
       auto alg = *ai;
       if ( alg->name() == System::typeinfoName( typeid( *alg ) ) )
         info() << alg->name();
       else
         info() << System::typeinfoName( typeid( *alg ) ) << "/" << alg->name();
 
       if ( *li ) info() << ":invert";
     }
     info() << endmsg;
   }
   return result;
 }

StatusCode Sequencer::endRun ( )

override

Sequencer endRun.

Definition at line 249 of file Sequencer.cpp.

 {
   // Bypass the loop if this sequencer is disabled
   if ( isEnabled() ) {
 
     // Loop over all members calling their endRun functions
     // if they are not disabled.
     for ( auto& alg : *subAlgorithms() ) {
       if ( !alg->isEnabled() ) alg->endRun().ignore();
     }
     // Loop over all branch members calling their endRun functions
     // if they are not disabled.
     for ( auto& alg : branchAlgorithms() ) {
       if ( !alg->isEnabled() ) alg->endRun().ignore();
     }
   }
   return StatusCode::SUCCESS;
 }

StatusCode Sequencer::execute ( )

override

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

This method is invoked once per event.

Definition at line 88 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::SUCCESS;
   ON_DEBUG debug() << name() << " Sequencer::execute( )" << endmsg;
 
   // Bypass the loop if this sequencer is disabled or has already been executed
   if ( isEnabled() && !isExecuted() ) {
     Algorithm* lastAlgorithm;
     result = execute( *subAlgorithms(), m_isInverted, lastAlgorithm );
     if ( result.isSuccess() ) {
       bool passed = filterPassed();
       if ( !passed && !isStopOverride() ) {
 
         // Filter failed and stop override not set. Execute the
         // branch if there is one associated with the filter
         // algorithm that failed. Note that the first member on
         // the branch is the failing algorithm and so should
         // be skipped.
         const auto& theAlgs = branchAlgorithms();
         if ( !theAlgs.empty() ) {
           Algorithm* branchAlgorithm = theAlgs[0];
           if ( lastAlgorithm == branchAlgorithm ) {
 
             // Branch specified - Loop over branch members
             result = execute( branchAlgorithms(), m_isBranchInverted, lastAlgorithm, 1 );
             if ( result.isSuccess() ) {
 
               // The final filter passed state will be set true if either
               // of the main or branches passed, otherwise false.
 
               // Save the branch  filter passed state.
               setBranchFilterPassed( filterPassed() ).ignore();
             }
           }
         }
       }
     }
 
     // Prevent multiple executions of this sequencer for the current event
     setExecuted( true );
   }
   return result;
 }

StatusCode Sequencer::execute	(	const std::vector< Algorithm * > &	theAlgs,
		std::vector< bool > &	theLogic,
		Algorithm *&	lastAlgorithm,
		unsigned int	first = `0`
	)

protected

Execute the members in the specified list.

Definition at line 471 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::SUCCESS;
 
   // Loop over all algorithms calling their execute functions if they
   // are (a) not disabled, and (b) aren't already executed. Note that
   // in the latter case the filter state is still examined. Terminate
   // the loop if an algorithm indicates that it's filter didn't pass.
   unsigned int size = theAlgs.size();
   for ( unsigned int i = first; i < size; i++ ) {
     lastAlgorithm = theAlgs[i];
     result        = executeMember( lastAlgorithm );
     if ( result.isSuccess() ) {
 
       // Take the filter passed status of this algorithm as my own status.
       // Note that we take into account inverted logic.
       bool passed              = lastAlgorithm->filterPassed();
       bool isInverted          = theLogic[i];
       if ( isInverted ) passed = !passed;
       setFilterPassed( passed );
 
       // The behaviour when the filter fails depends on the StopOverride property.
       // The default action is to stop processing, but this default can be
       // overridden by setting the "StopOverride" property to true.
       if ( !isStopOverride() ) {
         if ( !passed ) break;
       }
     } else {
       break;
     }
   }
   return result;
 }

StatusCode Sequencer::executeMember ( Algorithm * theAlgorithm )

protected

Execute member algorithm.

Definition at line 506 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::SUCCESS;
   if ( theAlgorithm->isEnabled() ) {
     if ( !theAlgorithm->isExecuted() ) {
       result = theAlgorithm->sysExecute( getContext() );
 
       // Set the executed state of the algorithm.
       // I think this should be done by the algorithm itself, but just in case...
       theAlgorithm->setExecuted( true );
     }
   }
   return result;
 }

StatusCode Sequencer::finalize ( )

override

Sequencer finalization.

Definition at line 132 of file Sequencer.cpp.

 {
   // Loop over all branch members calling their finalize functions
   // if they are not disabled. Note that the Algorithm::sysFinalize
   // function already does this for the main members.
   for ( auto& alg : branchAlgorithms() ) {
     if ( alg->sysFinalize().isFailure() ) {
       error() << "Unable to finalize Algorithm " << alg->name() << endmsg;
     }
   }
   return StatusCode::SUCCESS;
 }

StatusCode Sequencer::initialize ( )

override

Initialization of a sequencer.

Typically things like histogram creation, setting up of data structures etc, should be done here. If a sequence has properties specified in the job options file, they will be set to the requested values BEFORE the initialize() method is invoked.

Definition at line 31 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::SUCCESS;
 
   result = decodeMemberNames();
   if ( result.isFailure() ) {
     error() << "Unable to configure one or more sequencer members " << endmsg;
     return result;
   }
   result = decodeBranchMemberNames();
   if ( result.isFailure() ) {
     error() << "Unable to configure one or more branch members " << endmsg;
     return result;
   }
 
   // Loop over all sub-algorithms
   for ( auto& alg : *subAlgorithms() ) {
     result = alg->sysInitialize();
     if ( result.isFailure() ) {
       error() << "Unable to initialize Algorithm " << alg->name() << endmsg;
       return result;
     }
   }
 
   // Loop over all branches
   for ( auto& alg : branchAlgorithms() ) {
     result = alg->sysInitialize();
     if ( result.isFailure() ) {
       error() << "Unable to initialize Algorithm " << alg->name() << endmsg;
       return result;
     }
   }
 
   return result;
 }

bool Sequencer::isSequence ( ) const

inlinefinaloverride

additional interface methods

Identify as a Sequence

Definition at line 98 of file Sequencer.h.

98 { return true; }

bool Sequencer::isStopOverride ( ) const

virtual

Has the StopOverride mode been set?

Definition at line 292 of file Sequencer.cpp.

292 { return m_stopOverride.value(); }

Sequencer::m_stopOverride

Gaudi::Property< bool > m_stopOverride

Definition: Sequencer.h:234

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

protecteddelete

StatusCode Sequencer::reinitialize ( )

override

Sequencer Reinitialization.

Definition at line 67 of file Sequencer.cpp.

 {
   // Bypass the loop if this sequencer is disabled
   if ( isEnabled() ) {
 
     // Loop over all members calling their reinitialize functions
     // if they are not disabled.
     for ( auto& alg : *subAlgorithms() ) {
       if ( alg->isEnabled() ) alg->reinitialize().ignore();
     }
     // Loop over all branch members calling their reinitialize functions
     // if they are not disabled.
     for ( auto& alg : branchAlgorithms() ) {
       if ( alg->isEnabled() ) {
         alg->reinitialize().ignore();
       }
     }
   }
   return StatusCode::SUCCESS;
 }

StatusCode Sequencer::remove ( Algorithm * pAlgorithm )

Remove the specified algorithm from the sequencer.

Definition at line 309 of file Sequencer.cpp.

309 { return remove( pAlgorithm->name() ); }

Algorithm::name

const std::string & name() const override

The identifying name of the algorithm object.

Definition: Algorithm.cpp:731

StatusCode Sequencer::remove ( const std::string & name )

Definition at line 311 of file Sequencer.cpp.

311 { return remove( algname, *subAlgorithms() ); }

Algorithm::subAlgorithms

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

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

Definition: Algorithm.cpp:776

StatusCode Sequencer::remove	(	const std::string &	algname,
		std::vector< Algorithm * > &	theAlgs
	)

protected

Remove the specified algorithm from the sequencer.

Definition at line 521 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::FAILURE;
 
   // Test that the algorithm exists in the member list
   for ( auto& alg : theAlgs ) {
     if ( alg->name() == algname ) {
 
       // Algorithm with specified name exists in the algorithm list - remove it
       // THIS ISN'T IMPLEMENTED YET!!!!
       info() << "Sequencer::remove( ) isn't implemented yet!!!!!" << endmsg;
       result = StatusCode::SUCCESS;
       break;
     }
   }
   return result;
 }

StatusCode Sequencer::removeFromBranch ( Algorithm * pAlgorithm )

Definition at line 313 of file Sequencer.cpp.

313 { return removeFromBranch( pAlgorithm->name() ); }

Algorithm::name

const std::string & name() const override

The identifying name of the algorithm object.

Definition: Algorithm.cpp:731

Sequencer::removeFromBranch

StatusCode removeFromBranch(Algorithm *pAlgorithm)

Definition: Sequencer.cpp:313

StatusCode Sequencer::removeFromBranch ( const std::string & name )

Definition at line 315 of file Sequencer.cpp.

315 { return remove( algname, branchAlgorithms() ); }

Sequencer::branchAlgorithms

const std::vector< Algorithm * > & branchAlgorithms() const

List of branch algorithms.

Definition: Sequencer.cpp:317

void Sequencer::resetExecuted ( )

override

Reset the Sequencer executed state for the current event.

Definition at line 268 of file Sequencer.cpp.

 {
   Algorithm::resetExecuted();
 
   // Loop over all members calling their resetExecuted functions
   // if they are not disabled.
   for ( auto& alg : *subAlgorithms() ) alg->resetExecuted();
 
   // Loop over all branch members calling their resetExecuted functions
   // if they are not disabled.
   for ( auto& alg : branchAlgorithms() ) alg->resetExecuted();
 
   // Reset the branch filter passed flag
   m_branchFilterPassed = false;
 }

StatusCode Sequencer::setBranchFilterPassed ( bool state )

virtual

Set the branch filter passed flag for the last event.

Definition at line 286 of file Sequencer.cpp.

 {
   m_branchFilterPassed = state;
   return StatusCode::SUCCESS;
 }

StatusCode Sequencer::start ( )

override

Sequencer finalization.

Definition at line 145 of file Sequencer.cpp.

 {
   StatusCode result = StatusCode::SUCCESS;
 
   // Loop over all sub-algorithms
   for ( auto& alg : *subAlgorithms() ) {
     result = alg->sysStart();
     if ( result.isFailure() ) {
       error() << "Unable to start Algorithm " << alg->name() << endmsg;
       return result;
     }
   }
 
   // Loop over all branches
   for ( auto& alg : branchAlgorithms() ) {
     result = alg->sysStart();
     if ( result.isFailure() ) {
       error() << "Unable to start Algorithm " << alg->name() << endmsg;
       return result;
     }
   }
 
   return result;
 }

StatusCode Sequencer::stop ( )

override

Sequencer finalization.

Definition at line 170 of file Sequencer.cpp.

 {
   // Loop over all branch members calling their finalize functions
   // if they are not disabled.
 
   for ( auto& alg : *subAlgorithms() ) {
     if ( alg->sysStop().isFailure() ) {
       error() << "Unable to stop Algorithm " << alg->name() << endmsg;
     }
   }
 
   for ( auto& alg : branchAlgorithms() ) {
     if ( alg->sysStop().isFailure() ) {
       error() << "Unable to stop Algorithm " << alg->name() << endmsg;
     }
   }
   return StatusCode::SUCCESS;
 }

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

override

Produce string represention of the control flow expression.

Definition at line 539 of file Sequencer.cpp.

 {
   auto& theAlgs = *subAlgorithms();
   if ( theAlgs.empty() ) return os << "CFTrue";
 
   os << "seq(";
   const auto algs_count = theAlgs.size();
   const auto op         = isStopOverride() ? " >> " : " & ";
   size_t i              = 0;
   while ( i < algs_count ) {
     if ( i ) os << op;
     if ( m_isInverted[i] ) os << "~";
     theAlgs[i]->toControlFlowExpression( os );
     ++i;
   }
   return os << ")";
 }

Member Data Documentation

std::vector<Algorithm*> Sequencer::m_branchAlgs

private

Definition at line 237 of file Sequencer.h.

bool Sequencer::m_branchFilterPassed = false

private

Definition at line 240 of file Sequencer.h.

Gaudi::Property<std::vector<std::string> > Sequencer::m_branchNames {this, "BranchMembers", {}, "branch member names"}

private

Definition at line 233 of file Sequencer.h.

std::vector<bool> Sequencer::m_isBranchInverted

private

Definition at line 238 of file Sequencer.h.

std::vector<bool> Sequencer::m_isInverted

private

Definition at line 236 of file Sequencer.h.

Gaudi::Property<std::vector<std::string> > Sequencer::m_names {this, "Members", {}, "member names"}

private

Definition at line 232 of file Sequencer.h.

Gaudi::Property<bool> Sequencer::m_stopOverride {this, "StopOverride", false, "stop on filter failure override"}

private

Definition at line 234 of file Sequencer.h.

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

GaudiAlg/GaudiAlg/Sequencer.h
GaudiAlg/src/lib/Sequencer.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation