The Gaudi Framework  v30r0 (c919700c)
GaudiParallelizer Class Reference

#include <src/GaudiParallelizer.h>

Inheritance diagram for GaudiParallelizer:
Collaboration diagram for GaudiParallelizer:

Classes

class  AlgorithmEntry
 

Public Member Functions

 GaudiParallelizer (const std::string &name, ISvcLocator *pSvcLocator)
 Standard constructor. More...
 
 ~GaudiParallelizer () noexcept(true) override
 Destructor. An explicit noexcept(true) is necessary for Gaudi to build (see GAUDI-1187) More...
 
StatusCode initialize () override
 Algorithm initialization. More...
 
StatusCode execute () override
 Algorithm execution. More...
 
StatusCode finalize () override
 Algorithm finalization. More...
 
void membershipHandler (Gaudi::Details::PropertyBase &theProp)
 for asynchronous changes in the list of algorithms 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 (DataObject *object, const std::string &address, const bool useRootInTES=true) const
 Register a data object or container into Gaudi Event Transient Store. More...
 
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 (protected) More...
 
 ~GaudiAlgorithm () override=default
 destructor, virtual and protected More...
 
SmartIF< INTupleSvc > & evtColSvc () const
 Access the standard event collection service. More...
 
 GaudiAlgorithm (const GaudiAlgorithm &)=delete
 
GaudiAlgorithmoperator= (const GaudiAlgorithm &)=delete
 
- 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...
 
DataObjectput (IDataProviderSvc *svc, DataObject *object, const std::string &location, const bool useRootInTES=true) const
 Register a data object or container into Gaudi Event Transient Store. More...
 
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...
 
IUpdateManagerSvcupdMgrSvc () 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 Statisticscounters () const
 accessor to all counters More...
 
StatEntitycounter (const std::string &tag) const
 accessor to certain counter by name More...
 
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 Servicesservices () const
 get the list of aquired services More...
 
const std::stringcontext () const
 Returns the "context" string. Used to identify different processing states. More...
 
const std::stringrootInTES () 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::stringname () const override
 The identifying name of the algorithm object. More...
 
const Gaudi::StringKeynameKey () const override
 
const std::stringtype () const override
 The type of the algorithm object. More...
 
void setType (const std::string &type) override
 
const std::stringversion () 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< IServiceservice (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::PropertyBasedeclareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (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 EventContextgetContext () 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::ostreamtoControlFlowExpression (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 DataObjIDCollextraInputDeps () const override
 
virtual const DataObjIDCollextraOutputDeps () const override
 
void declare (Gaudi::DataHandle &handle) override
 
void renounce (Gaudi::DataHandle &handle) override
 
const DataObjIDCollinputDataObjs () const override
 
const DataObjIDColloutputDataObjs () 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::stringgetInterfaceNames () 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::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareRemoteProperty (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::PropertyBasegetProperty (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
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
 Specializations for various GaudiHandles. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
const SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the cached level (originally extracted 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 decodeNames ()
 Decode a vector of string. More...
 
- Protected Member Functions inherited from GaudiCommon< Algorithm >
 ~GaudiCommon () override=default
 Destructor. More...
 
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...
 
- 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::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level setUpMessaging ()
 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...
 

Private Attributes

Gaudi::Property< std::vector< std::string > > m_names {this, "Members", {}, "list of algorithms"}
 
Gaudi::Property< bool > m_modeOR {this, "ModeOR", false, "use OR loginc instead of AND"}
 
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< unsigned short > m_nthreads {this, "NumberOfThreads", 0, "number of threads in the thread pool"}
 
std::vector< AlgorithmEntrym_entries
 List of algorithms to process. More...
 
ISequencerTimerToolm_timerTool = nullptr
 Pointer to the timer tool. More...
 
int m_timer
 Timer number for the sequencer. More...
 
tbb::task_group m_task_group
 TBB task group. More...
 

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...
 
- Public Attributes inherited from Algorithm
friend AlgorithmManager
 
- Protected Types inherited from GaudiCommon< Algorithm >
using base_class = Algorithm
 
typedef std::map< std::string, StatEntityStatistics
 the actual type of general counters More...
 
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 Attributes inherited from GaudiCommon< Algorithm >
SmartIF< ICounterSummarySvcm_counterSummarySvc
 a pointer to the CounterSummarySvc More...
 
- Protected Attributes inherited from Algorithm
std::unique_ptr< IDataHandleVisitorm_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

Author
Illya Shapoval
Date
09/12/2011

Definition at line 21 of file GaudiParallelizer.h.

Constructor & Destructor Documentation

GaudiParallelizer::GaudiParallelizer ( const std::string name,
ISvcLocator pSvcLocator 
)

Standard constructor.

Definition at line 20 of file GaudiParallelizer.cpp.

21  : GaudiAlgorithm( name, pSvcLocator )
22 {
23  m_names.declareUpdateHandler( &GaudiParallelizer::membershipHandler, this );
24 }
void membershipHandler(Gaudi::Details::PropertyBase &theProp)
for asynchronous changes in the list of algorithms
Gaudi::Property< std::vector< std::string > > m_names
GaudiParallelizer::~GaudiParallelizer ( )
inlineoverridenoexcept

Destructor. An explicit noexcept(true) is necessary for Gaudi to build (see GAUDI-1187)

Definition at line 27 of file GaudiParallelizer.h.

27 {}

Member Function Documentation

StatusCode GaudiParallelizer::decodeNames ( )
protected

Decode a vector of string.

Definition at line 124 of file GaudiParallelizer.cpp.

125 {
126 
128  m_entries.clear();
129 
130  //== Get the "Context" option if in the file...
131  auto jos = service<IJobOptionsSvc>( "JobOptionsSvc" );
132  bool addedContext = false; //= Have we added the context ?
133  bool addedRootInTES = false; //= Have we added the rootInTES ?
134 
135  //= Get the Application manager, to see if algorithm exist
136  auto appMgr = service<IAlgManager>( "ApplicationMgr" );
137  const std::vector<std::string>& nameVector = m_names.value();
139  for ( it = nameVector.begin(); nameVector.end() != it; it++ ) {
141  const std::string& theName = typeName.name();
142  const std::string& theType = typeName.type();
143 
144  //== Check whether the specified algorithm already exists. If not, create it
146  SmartIF<IAlgorithm> myIAlg = appMgr->algorithm( typeName, false ); // do not create it now
147  if ( !myIAlg.isValid() ) {
148  //== Set the Context if not in the jobOptions list
149  if ( !context().empty() || !rootInTES().empty() ) {
150  bool foundContext = false;
151  bool foundRootInTES = false;
152  const auto properties = jos->getProperties( theName );
153  if ( properties ) {
154  // Iterate over the list to set the options
155  for ( const auto& p : *properties ) {
156  if ( "Context" == p->name() ) {
157  foundContext = true;
158  }
159  if ( "RootInTES" == p->name() ) {
160  foundRootInTES = true;
161  }
162  }
163  }
164  if ( !foundContext && !context().empty() ) {
165  Gaudi::Property<std::string> contextProperty( "Context", context() );
166  jos->addPropertyToCatalogue( theName, contextProperty ).ignore();
167  addedContext = true;
168  }
169  if ( !foundRootInTES && !rootInTES().empty() ) {
170  Gaudi::Property<std::string> rootInTESProperty( "RootInTES", rootInTES() );
171  jos->addPropertyToCatalogue( theName, rootInTESProperty ).ignore();
172  addedRootInTES = true;
173  }
174  }
175 
176  Algorithm* myAlg = nullptr;
177  result = createSubAlgorithm( theType, theName, myAlg );
178  // (MCl) this should prevent bug #35199... even if I didn't manage to
179  // reproduce it with a simple test.
180  if ( result.isSuccess() ) myIAlg = myAlg;
181  } else {
182  Algorithm* myAlg = dynamic_cast<Algorithm*>( myIAlg.get() );
183  if ( myAlg ) {
184  subAlgorithms()->push_back( myAlg );
185  // when the algorithm is not created, the ref count is short by one, so we have to fix it.
186  myAlg->addRef();
187  }
188  }
189 
190  //== Remove the property, in case this is not a GaudiAlgorithm...
191  if ( addedContext ) {
192  jos->removePropertyFromCatalogue( theName, "Context" ).ignore();
193  addedContext = false;
194  }
195  if ( addedRootInTES ) {
196  jos->removePropertyFromCatalogue( theName, "RootInTES" ).ignore();
197  addedRootInTES = false;
198  }
199 
200  // propagate the sub-algorithm into own state.
201  if ( result.isSuccess() && Gaudi::StateMachine::INITIALIZED <= FSMState() && myIAlg.isValid() &&
202  Gaudi::StateMachine::INITIALIZED > myIAlg->FSMState() ) {
203  StatusCode sc = myIAlg->sysInitialize();
204  if ( sc.isFailure() ) {
205  result = sc;
206  }
207  }
208 
209  // propagate the sub-algorithm into own state.
210  if ( result.isSuccess() && Gaudi::StateMachine::RUNNING <= FSMState() && myIAlg.isValid() &&
211  Gaudi::StateMachine::RUNNING > myIAlg->FSMState() ) {
212  StatusCode sc = myIAlg->sysStart();
213  if ( sc.isFailure() ) {
214  result = sc;
215  }
216  }
217 
218  //== Is it an Algorithm ? Strange test...
219  if ( result.isSuccess() ) {
220  // TODO: (MCl) it is possible to avoid the dynamic_cast in most of the
221  // cases by keeping the result of createSubAlgorithm.
222  Algorithm* myAlg = dynamic_cast<Algorithm*>( myIAlg.get() );
223  if ( myAlg != 0 ) {
224  // Note: The reference counting is kept by the system of sub-algorithms
225  m_entries.push_back( AlgorithmEntry( myAlg ) );
226  if ( msgLevel( MSG::DEBUG ) ) debug() << "Added algorithm " << theName << endmsg;
227  } else {
228  warning() << theName << " is not an Algorithm - failed dynamic_cast" << endmsg;
229  final = StatusCode::FAILURE;
230  }
231  } else {
232  warning() << "Unable to find or create " << theName << endmsg;
233  final = result;
234  }
235  }
236  //== Print the list of algorithms
237  MsgStream& msg = info();
238  if ( m_modeOR ) msg << "OR ";
239  msg << "Member list: ";
241  ostream_joiner( msg, m_entries, ", ", []( MsgStream& msg, const AlgorithmEntry& entry ) -> MsgStream& {
242  Algorithm* myAlg = entry.algorithm();
243  auto myAlgType = System::typeinfoName( typeid( *myAlg ) );
244  if ( myAlg->name() != myAlgType ) {
245  msg << myAlgType << "/";
246  }
247  return msg << myAlg->name();
248  } );
249  if ( !context().empty() ) msg << ", with context '" << context() << "'";
250  if ( !rootInTES().empty() ) msg << ", with rootInTES '" << rootInTES() << "'";
251  msg << endmsg;
252  return final;
253 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
T empty(T...args)
Gaudi::Property< bool > m_modeOR
StatusCode createSubAlgorithm(const std::string &type, const std::string &name, Algorithm *&pSubAlg)
Create a sub algorithm.
Definition: Algorithm.cpp:842
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:737
Implementation of property with value of concrete type.
Definition: Property.h:319
virtual StatusCode sysStart()=0
Startup method invoked by the framework.
const std::string & rootInTES() const
Returns the "rootInTES" string.
Definition: GaudiCommon.h:721
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:336
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
const std::string & context() const
Returns the "context" string. Used to identify different processing states.
Definition: GaudiCommon.h:717
T end(T...args)
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:61
virtual StatusCode sysInitialize()=0
Initialization method invoked by the framework.
STL class.
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:82
T push_back(T...args)
Helper class to parse a string of format "type/name".
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
Stream & ostream_joiner(Stream &os, Iterator first, Iterator last, Separator sep, OutputElement output=OutputElement{})
Definition: SerializeSTL.h:40
const std::vector< Algorithm * > * subAlgorithms() const
List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms.
Definition: Algorithm.cpp:782
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:79
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:68
T begin(T...args)
std::vector< AlgorithmEntry > m_entries
List of algorithms to process.
appMgr
Definition: IOTest.py:94
Gaudi::Property< std::vector< std::string > > m_names
std::string typeName(const std::type_info &typ)
Definition: Dictionary.cpp:23
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
Gaudi::StateMachine::State FSMState() const override
returns the current state of the algorithm
Definition: Algorithm.h:193
StatusCode GaudiParallelizer::execute ( )
override

Algorithm execution.

Definition at line 80 of file GaudiParallelizer.cpp.

81 {
83 
84  if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Execute algorithms in parallel" << endmsg;
85 
86  for ( std::vector<AlgorithmEntry>::iterator itE = m_entries.begin(); m_entries.end() != itE; ++itE ) {
87  Algorithm* myAlg = itE->algorithm();
88  if ( !myAlg->isEnabled() ) continue;
89  if ( !myAlg->isExecuted() ) {
90 
91  m_task_group.run( boost::bind( &AlgorithmEntry::run, boost::ref( *itE ), boost::ref( *this ) ) );
92  }
93  }
94 
95  m_task_group.wait();
96  if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Joining parallel algorithm tasks" << endmsg;
97 
98  for ( std::vector<AlgorithmEntry>::const_iterator it = m_entries.begin(); it != m_entries.end(); ++it ) {
99  if ( msgLevel( MSG::DEBUG ) )
100  debug() << "Algorithm wrapper " << &*it << " around the algorithm " << it->algorithm()->name()
101  << " received return status code " << it->m_returncode << endmsg;
102  }
103 
104  for ( std::vector<AlgorithmEntry>::const_iterator it = m_entries.begin(); it != m_entries.end(); ++it )
105  if ( !( it->m_returncode.isSuccess() ) ) return it->m_returncode;
106 
107  setExecuted( true );
109  return StatusCode::SUCCESS;
110 }
Gaudi::Property< bool > m_measureTime
bool isExecuted() const override
Has this algorithm been executed since the last reset?
Definition: Algorithm.cpp:747
bool isEnabled() const override
Is this algorithm enabled or disabled?
Definition: Algorithm.cpp:766
tbb::task_group m_task_group
TBB task group.
virtual void start(int index)=0
start the counter, i.e.
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:79
STL class.
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
std::vector< AlgorithmEntry > m_entries
List of algorithms to process.
void setExecuted(bool state) const override
Set the executed flag to the specified state.
Definition: Algorithm.cpp:753
ISequencerTimerTool * m_timerTool
Pointer to the timer tool.
int m_timer
Timer number for the sequencer.
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
virtual double stop(int index)=0
stop the counter, return the elapsed time
void run(GaudiParallelizer &prlzr)
Thread task executor method to wrap an algorithm execution in.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCode GaudiParallelizer::finalize ( )
override

Algorithm finalization.

Definition at line 115 of file GaudiParallelizer.cpp.

116 {
117  if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Finalize" << endmsg;
118 
119  return GaudiAlgorithm::finalize(); // must be called after all other actions
120 }
StatusCode finalize() override
standard finalization method
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCode GaudiParallelizer::initialize ( )
override

Algorithm initialization.

Definition at line 29 of file GaudiParallelizer.cpp.

30 {
31  if ( msgLevel( MSG::DEBUG ) ) debug() << "==> Initialize" << endmsg;
32  StatusCode sc = GaudiAlgorithm::initialize(); // must be executed first
33  if ( sc.isFailure() ) return sc; // error printed already by GaudiAlgorithm
34 
35  StatusCode status = decodeNames();
36  if ( !status.isSuccess() ) return status;
37 
38  m_timerTool = tool<ISequencerTimerTool>( "SequencerTimerTool" );
39  if ( m_timerTool->globalTiming() ) m_measureTime = true;
40 
41  if ( m_measureTime ) {
44  } else {
46  m_timerTool = 0;
47  }
48 
49  //== Initialize the algorithms
51  for ( itE = m_entries.begin(); m_entries.end() != itE; itE++ ) {
52  Algorithm* myAlg = itE->algorithm();
53  if ( m_measureTime ) {
54  itE->setTimer( m_timerTool->addTimer( myAlg->name() ) );
55  }
56 
57  status = myAlg->sysInitialize();
58  if ( !status.isSuccess() ) {
59  return Error( "Can not initialize " + myAlg->name(), status );
60  }
61  }
62 
64 
65  if ( m_nthreads != 0 ) {
66  // Construct the TBB task scheduler with m_nthreads threads
67  tbb::task_scheduler_init init( m_nthreads );
68  } else {
69  m_nthreads = tbb::task_scheduler_init::default_num_threads();
70  }
71 
72  if ( msgLevel( MSG::DEBUG ) )
73  debug() << "Number of threads set to be used in the TBB thread pool is " << m_nthreads << endmsg;
74  return StatusCode::SUCCESS;
75 }
Gaudi::Property< bool > m_measureTime
virtual void decreaseIndent()=0
Decrease the indentation of the name.
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:737
virtual int addTimer(const std::string &name)=0
add a timer entry with the specified name
StatusCode initialize() override
standard initialization method
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:50
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.
StatusCode decodeNames()
Decode a vector of string.
virtual void increaseIndent()=0
Increase the indentation of the name.
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:61
virtual bool globalTiming()=0
returns the flag telling that global timing is wanted
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
Gaudi::Property< unsigned short > m_nthreads
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:79
STL class.
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
std::vector< AlgorithmEntry > m_entries
List of algorithms to process.
ISequencerTimerTool * m_timerTool
Pointer to the timer tool.
int m_timer
Timer number for the sequencer.
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
StatusCode sysInitialize() override
Initialization method invoked by the framework.
Definition: Algorithm.cpp:78
StatusCode release(const IInterface *interface) const
Manual forced (and &#39;safe&#39;) release of the active tool or service.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
void GaudiParallelizer::membershipHandler ( Gaudi::Details::PropertyBase theProp)

for asynchronous changes in the list of algorithms

Definition at line 258 of file GaudiParallelizer.cpp.

259 {
260  // no action for not-yet initialized sequencer
262  return;
263  } // RETURN
264 
265  decodeNames().ignore();
266 
267  if ( !m_measureTime ) {
268  return;
269  } // RETURN
270 
271  // add the entries into timer table:
272 
273  if ( 0 == m_timerTool ) {
274  m_timerTool = tool<ISequencerTimerTool>( "SequencerTimerTool" );
275  }
276 
277  if ( m_timerTool->globalTiming() ) m_measureTime = true;
278 
281 
282  for ( std::vector<AlgorithmEntry>::iterator itE = m_entries.begin(); m_entries.end() != itE; ++itE ) {
283  itE->setTimer( m_timerTool->addTimer( itE->algorithm()->name() ) );
284  }
285 
287 }
Gaudi::Property< bool > m_measureTime
virtual void decreaseIndent()=0
Decrease the indentation of the name.
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:737
virtual int addTimer(const std::string &name)=0
add a timer entry with the specified name
StatusCode decodeNames()
Decode a vector of string.
virtual void increaseIndent()=0
Increase the indentation of the name.
virtual bool globalTiming()=0
returns the flag telling that global timing is wanted
STL class.
std::vector< AlgorithmEntry > m_entries
List of algorithms to process.
ISequencerTimerTool * m_timerTool
Pointer to the timer tool.
int m_timer
Timer number for the sequencer.
void ignore() const
Definition: StatusCode.h:84
Gaudi::StateMachine::State FSMState() const override
returns the current state of the algorithm
Definition: Algorithm.h:193

Member Data Documentation

std::vector<AlgorithmEntry> GaudiParallelizer::m_entries
private

List of algorithms to process.

Definition at line 82 of file GaudiParallelizer.h.

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

Definition at line 78 of file GaudiParallelizer.h.

Gaudi::Property<bool> GaudiParallelizer::m_modeOR {this, "ModeOR", false, "use OR loginc instead of AND"}
private

Definition at line 77 of file GaudiParallelizer.h.

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

Definition at line 76 of file GaudiParallelizer.h.

Gaudi::Property<unsigned short> GaudiParallelizer::m_nthreads {this, "NumberOfThreads", 0, "number of threads in the thread pool"}
private

Definition at line 80 of file GaudiParallelizer.h.

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

Definition at line 79 of file GaudiParallelizer.h.

tbb::task_group GaudiParallelizer::m_task_group
private

TBB task group.

Definition at line 87 of file GaudiParallelizer.h.

int GaudiParallelizer::m_timer
private

Timer number for the sequencer.

Definition at line 85 of file GaudiParallelizer.h.

ISequencerTimerTool* GaudiParallelizer::m_timerTool = nullptr
private

Pointer to the timer tool.

Definition at line 84 of file GaudiParallelizer.h.


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