The Gaudi Framework  v32r2 (46d42edc)
EventLoopMgr Class Reference

Class definition of EventLoopMgr. More...

#include <src/ApplicationMgr/EventLoopMgr.h>

Inheritance diagram for EventLoopMgr:
Collaboration diagram for EventLoopMgr:

Public Member Functions

 ~EventLoopMgr () override
 Standard Destructor. More...
 
StatusCode getEventRoot (IOpaqueAddress *&refpAddr)
 Create event address using event selector. More...
 
StatusCode initialize () override
 implementation of IService::initialize More...
 
StatusCode reinitialize () override
 implementation of IService::reinitialize More...
 
StatusCode stop () override
 implementation of IService::stop More...
 
StatusCode finalize () override
 implementation of IService::finalize More...
 
StatusCode nextEvent (int maxevt) override
 implementation of IEventProcessor::nextEvent More...
 
StatusCode executeEvent (EventContext &&ctx) override
 implementation of IEventProcessor::executeEvent(EventContext&&) More...
 
 MinimalEventLoopMgr (const std::string &nam, ISvcLocator *svcLoc)
 Standard Constructor. More...
 
 MinimalEventLoopMgr (const MinimalEventLoopMgr &)=delete
 No copy allowed. More...
 
- Public Member Functions inherited from MinimalEventLoopMgr
 MinimalEventLoopMgr (const std::string &nam, ISvcLocator *svcLoc)
 Standard Constructor. More...
 
 MinimalEventLoopMgr (const MinimalEventLoopMgr &)=delete
 No copy allowed. More...
 
MinimalEventLoopMgroperator= (const MinimalEventLoopMgr &)=delete
 No copy allowed. More...
 
StatusCode initialize () override
 implementation of IService::initialize More...
 
StatusCode start () override
 implementation of IService::start More...
 
StatusCode stop () override
 implementation of IService::stop More...
 
StatusCode finalize () override
 implementation of IService::finalize More...
 
StatusCode reinitialize () override
 implementation of IService::reinitialize More...
 
StatusCode restart () override
 implementation of IService::restart More...
 
EventContext createEventContext () override
 implementation of IEventProcessor::createEventContext() More...
 
StatusCode nextEvent (int maxevt) override
 implementation of IEventProcessor::nextEvent More...
 
StatusCode executeEvent (EventContext &&ctx) override
 implementation of IEventProcessor::executeEvent(EventContext&&) More...
 
StatusCode executeRun (int maxevt) override
 implementation of IEventProcessor::executeRun( ) More...
 
StatusCode stopRun () override
 implementation of IEventProcessor::stopRun( ) More...
 
void topAlgHandler (Gaudi::Details::PropertyBase &p)
 Top algorithm List handler. More...
 
StatusCode decodeTopAlgs ()
 decodeTopAlgNameList & topAlgNameListHandler More...
 
void outStreamHandler (Gaudi::Details::PropertyBase &p)
 Output stream List handler. More...
 
StatusCode decodeOutStreams ()
 decodeOutStreamNameList & outStreamNameListHandler More...
 
- Public Member Functions inherited from extends< Service, IEventProcessor >
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...
 
- Public Member Functions inherited from Service
const std::stringname () const override
 Retrieve name of the service. More...
 
StatusCode configure () override
 
StatusCode initialize () override
 
StatusCode start () override
 
StatusCode stop () override
 
StatusCode finalize () override
 
StatusCode terminate () override
 
Gaudi::StateMachine::State FSMState () const override
 
Gaudi::StateMachine::State targetFSMState () const override
 
StatusCode reinitialize () override
 
StatusCode restart () override
 
StatusCode sysInitialize () override
 Initialize Service. More...
 
StatusCode sysStart () override
 Initialize Service. More...
 
StatusCode sysStop () override
 Initialize Service. More...
 
StatusCode sysFinalize () override
 Finalize Service. More...
 
StatusCode sysReinitialize () override
 Re-initialize the Service. More...
 
StatusCode sysRestart () override
 Re-initialize the Service. More...
 
 Service (std::string name, ISvcLocator *svcloc)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator. More...
 
StatusCode setProperties ()
 Method for setting declared properties to the values specified for the job. More...
 
template<class T >
StatusCode service (const std::string &name, const 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 &name, T *&psvc, bool createIf=true) const
 
template<typename IFace = IService>
SmartIF< IFace > service (const std::string &name, bool createIf=true) const
 
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...
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
 Declare used tool. More...
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 PropertyHolder ()=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, 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
 
- Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level msgLevel () const
 get the cached level (originally extracted from the embedded MsgStream) More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const
 Backward compatibility function for getting the output level. More...
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
const SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
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...
 

Protected Attributes

Gaudi::Property< std::stringm_histPersName {this, "HistogramPersistency", {}, "name of the Hist Pers type"}
 
Gaudi::Property< std::stringm_evtsel {this, "EvtSel", {}, "event selector"}
 
Gaudi::Property< bool > m_warnings {this, "Warnings", true, "set to false to suppress warning messages"}
 
SmartIF< IDataManagerSvcm_evtDataMgrSvc = nullptr
 Reference to the Event Data Service's IDataManagerSvc interface. More...
 
SmartIF< IDataProviderSvcm_evtDataSvc = nullptr
 Reference to the Event Data Service's IDataProviderSvc interface. More...
 
SmartIF< IEvtSelectorm_evtSelector = nullptr
 Reference to the Event Selector. More...
 
IEvtSelector::Contextm_evtContext = nullptr
 Event Iterator. More...
 
SmartIF< IDataManagerSvcm_histoDataMgrSvc = nullptr
 Reference to the Histogram Data Service. More...
 
SmartIF< IConversionSvcm_histoPersSvc = nullptr
 Reference to the Histogram Persistency Service. More...
 
SmartIF< IPropertym_appMgrProperty = nullptr
 Property interface of ApplicationMgr. More...
 
bool m_endEventFired = true
 Flag to avoid to fire the EnvEvent incident twice in a row (and also not before the first event) More...
 
- Protected Attributes inherited from MinimalEventLoopMgr
Gaudi::Property< std::vector< std::string > > m_topAlgNames
 
Gaudi::Property< std::vector< std::string > > m_outStreamNames
 
Gaudi::Property< std::stringm_outStreamType
 
Gaudi::Property< bool > m_printCFExp
 
SmartIF< IAppMgrUIm_appMgrUI
 Reference to the IAppMgrUI interface of the application manager. More...
 
SmartIF< IIncidentSvcm_incidentSvc
 Reference to the incident service. More...
 
SmartIF< IAlgExecStateSvcm_aess
 List of top level algorithms. More...
 
ListAlg m_topAlgList
 
ListAlg m_outStreamList
 List of output streams. More...
 
State m_state = OFFLINE
 State of the object. More...
 
bool m_scheduledStop = false
 Scheduled stop of event processing. More...
 
AbortEventListener m_abortEventListener
 Instance of the incident listener waiting for AbortEvent. More...
 
SmartIF< IHiveWhiteBoardm_WB
 < Event data service (whiteboard) More...
 
size_t m_nevt {0}
 
- Protected Attributes inherited from Service
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::Property< int > m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
 
Gaudi::Property< bool > m_auditInit {this, "AuditServices", false, " unused"}
 
Gaudi::Property< bool > m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
 
Gaudi::Property< bool > m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
 
Gaudi::Property< bool > m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
 
Gaudi::Property< bool > m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
 
Gaudi::Property< bool > m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
 
Gaudi::Property< bool > m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
 
SmartIF< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Additional Inherited Members

- Public Types inherited from MinimalEventLoopMgr
typedef std::vector< SmartIF< IAlgorithm > > ListAlg
 
- Public Types inherited from extends< Service, IEventProcessor >
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 Service
using Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IService, 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 Types inherited from MinimalEventLoopMgr
enum  State { OFFLINE, CONFIGURED, FINALIZED, INITIALIZED }
 
- Protected Member Functions inherited from Service
 ~Service () override
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level setUpMessaging () const
 Set up local caches. More...
 
MSG::Level resetMessaging ()
 Reinitialize internal states. More...
 
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 

Detailed Description

Class definition of EventLoopMgr.

This is the default processing manager of the application manager. This object handles the minimal requirements needed by the application manager. It also handles the default user configuration setup for standard event processing.

  • handling of the incidents when starting event processing
  • handling of the event loop

History:

 +---------+----------------------------------------------+---------+
 |    Date |                 Comment                      | Who     |
 +---------+----------------------------------------------+---------+
 |13/12/00 | Initial version                              | M.Frank |
 +---------+----------------------------------------------+---------+
 
Author
Markus Frank
Version
1.0

Definition at line 34 of file EventLoopMgr.h.

Constructor & Destructor Documentation

◆ ~EventLoopMgr()

EventLoopMgr::~EventLoopMgr ( )
override

Standard Destructor.

Definition at line 21 of file EventLoopMgr.cpp.

21 { delete m_evtContext; }
IEvtSelector::Context * m_evtContext
Event Iterator.
Definition: EventLoopMgr.h:50

Member Function Documentation

◆ executeEvent()

StatusCode EventLoopMgr::executeEvent ( EventContext &&  ctx)
override

implementation of IEventProcessor::executeEvent(EventContext&&)

Definition at line 232 of file EventLoopMgr.cpp.

232  {
233 
234  // DP Monitoring
235 
236  // Fire BeginEvent "Incident"
237  m_incidentSvc->fireIncident( Incident( name(), IncidentType::BeginEvent ) );
238  // An incident may schedule a stop, in which case is better to exit before the actual execution.
239  if ( m_scheduledStop ) {
240  always() << "Terminating event processing loop due to a stop scheduled by an incident listener" << endmsg;
241  return StatusCode::SUCCESS;
242  }
243 
244  // Execute Algorithms
245  m_incidentSvc->fireIncident( Incident( name(), IncidentType::BeginProcessing ) );
247  m_incidentSvc->fireIncident( Incident( name(), IncidentType::EndProcessing ) );
248 
249  // Check if there was an error processing current event
250  if ( UNLIKELY( !sc.isSuccess() ) ) { error() << "Terminating event processing loop due to errors" << endmsg; }
251  return sc;
252 }
#define UNLIKELY(x)
Definition: Kernel.h:96
bool m_scheduledStop
Scheduled stop of event processing.
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
MsgStream & always() const
shortcut for the method msgStream(MSG::ALWAYS)
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
virtual void fireIncident(const Incident &incident)=0
Fire an Incident.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
SmartIF< IIncidentSvc > m_incidentSvc
Reference to the incident service.
T move(T... args)
StatusCode executeEvent(EventContext &&ctx) override
implementation of IEventProcessor::executeEvent(EventContext&&)
Base class for all Incidents (computing events).
Definition: Incident.h:17
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ finalize()

StatusCode EventLoopMgr::finalize ( )
override

implementation of IService::finalize

Definition at line 171 of file EventLoopMgr.cpp.

171  {
172  // Finalize base class
174  if ( !sc.isSuccess() ) {
175  error() << "Error finalizing base class" << endmsg;
176  return sc;
177  }
178 
179  // Save Histograms Now
180  if ( m_histoPersSvc ) {
181  std::vector<DataObject*> objects;
182  sc = m_histoDataMgrSvc->traverseTree( [&objects]( IRegistry* reg, int ) {
183  DataObject* obj = reg->object();
184  if ( !obj || obj->clID() == CLID_StatisticsFile ) return false;
185  objects.push_back( obj );
186  return true;
187  } );
188  if ( sc.isSuccess() ) {
189  // skip /stat entry!
190  sc = std::accumulate( begin( objects ), end( objects ), sc, [&]( StatusCode isc, auto& i ) {
191  IOpaqueAddress* pAddr = nullptr;
192  StatusCode iret = m_histoPersSvc->createRep( i, pAddr );
193  if ( iret.isFailure() ) return iret;
194  i->registry()->setAddress( pAddr );
195  return isc;
196  } );
197  sc = std::accumulate( begin( objects ), end( objects ), sc, [&]( StatusCode isc, auto& i ) {
198  IRegistry* reg = i->registry();
199  StatusCode iret = m_histoPersSvc->fillRepRefs( reg->address(), i );
200  return iret.isFailure() ? iret : isc;
201  } );
202  if ( sc.isSuccess() ) {
203  info() << "Histograms converted successfully according to request." << endmsg;
204  } else {
205  error() << "Error while saving Histograms." << endmsg;
206  }
207  } else {
208  error() << "Error while traversing Histogram data store" << endmsg;
209  }
210  }
211 
212  // Release event selector context
213  if ( m_evtSelector && m_evtContext ) {
215  m_evtContext = nullptr;
216  }
217 
218  // Release all interfaces...
219  m_histoDataMgrSvc = nullptr;
220  m_histoPersSvc = nullptr;
221 
222  m_evtSelector = nullptr;
223  m_evtDataSvc = nullptr;
224  m_evtDataMgrSvc = nullptr;
225 
226  return StatusCode::SUCCESS;
227 }
virtual StatusCode traverseTree(IDataStoreAgent *pAgent)=0
Analyse by traversing all data objects in the data store.
StatusCode finalize() override
implementation of IService::finalize
SmartIF< IConversionSvc > m_histoPersSvc
Reference to the Histogram Persistency Service.
Definition: EventLoopMgr.h:54
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
virtual StatusCode createRep(DataObject *pObject, IOpaqueAddress *&refpAddress)=0
Convert the transient object to the requested representation.
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
T push_back(T... args)
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode releaseContext(Context *&) const =0
Release the Context object.
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
def end
Definition: IOTest.py:113
bool isSuccess() const
Definition: StatusCode.h:267
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.
virtual DataObject * object() const =0
Retrieve object behind the link.
SmartIF< IDataManagerSvc > m_evtDataMgrSvc
Reference to the Event Data Service's IDataManagerSvc interface.
Definition: EventLoopMgr.h:44
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
virtual const CLID & clID() const
Retrieve reference to class definition structure.
Definition: DataObject.cpp:56
IEvtSelector::Context * m_evtContext
Event Iterator.
Definition: EventLoopMgr.h:50
SmartIF< IEvtSelector > m_evtSelector
Reference to the Event Selector.
Definition: EventLoopMgr.h:48
SmartIF< IDataProviderSvc > m_evtDataSvc
Reference to the Event Data Service's IDataProviderSvc interface.
Definition: EventLoopMgr.h:46
bool isFailure() const
Definition: StatusCode.h:130
AttribStringParser::Iterator begin(const AttribStringParser &parser)
T accumulate(T... args)
Opaque address interface definition.
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
virtual StatusCode fillRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Resolve the references of the converted object.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
SmartIF< IDataManagerSvc > m_histoDataMgrSvc
Reference to the Histogram Data Service.
Definition: EventLoopMgr.h:52

◆ getEventRoot()

StatusCode EventLoopMgr::getEventRoot ( IOpaqueAddress *&  refpAddr)

Create event address using event selector.

Definition at line 348 of file EventLoopMgr.cpp.

348  {
349  refpAddr = nullptr;
351  if ( !sc.isSuccess() ) return sc;
352  // Create root address and assign address to data service
353  sc = m_evtSelector->createAddress( *m_evtContext, refpAddr );
354  if ( !sc.isSuccess() ) {
355  sc = m_evtSelector->next( *m_evtContext );
356  if ( sc.isSuccess() ) {
357  sc = m_evtSelector->createAddress( *m_evtContext, refpAddr );
358  if ( !sc.isSuccess() ) warning() << "Error creating IOpaqueAddress." << endmsg;
359  }
360  }
361  return sc;
362 }
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode next(Context &c) const =0
Fetch the next event or the first event if it will be use soon after the creation of the context.
bool isSuccess() const
Definition: StatusCode.h:267
IEvtSelector::Context * m_evtContext
Event Iterator.
Definition: EventLoopMgr.h:50
SmartIF< IEvtSelector > m_evtSelector
Reference to the Event Selector.
Definition: EventLoopMgr.h:48
virtual StatusCode createAddress(const Context &c, IOpaqueAddress *&iop) const =0
Create an IOpaqueAddress object from the event fetched.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ initialize()

StatusCode EventLoopMgr::initialize ( )
override

implementation of IService::initialize

Definition at line 26 of file EventLoopMgr.cpp.

26  {
27  // Initialize the base class
29  if ( !sc.isSuccess() ) {
30  DEBMSG << "Error Initializing base class MinimalEventLoopMgr." << endmsg;
31  return sc;
32  }
33 
34  // Setup access to event data services
35  m_evtDataMgrSvc = serviceLocator()->service( "EventDataSvc" );
36  if ( !m_evtDataMgrSvc ) {
37  fatal() << "Error retrieving EventDataSvc interface IDataManagerSvc." << endmsg;
38  return StatusCode::FAILURE;
39  }
40  m_evtDataSvc = serviceLocator()->service( "EventDataSvc" );
41  if ( !m_evtDataSvc ) {
42  fatal() << "Error retrieving EventDataSvc interface IDataProviderSvc." << endmsg;
43  return StatusCode::FAILURE;
44  }
45 
46  // Obtain the IProperty of the ApplicationMgr
48  if ( !m_appMgrProperty ) {
49  fatal() << "IProperty interface not found in ApplicationMgr." << endmsg;
50  return StatusCode::FAILURE;
51  }
52 
53  // We do not expect a Event Selector necessarily being declared
54  setProperty( m_appMgrProperty->getProperty( "EvtSel" ) ).ignore();
55 
56  if ( m_evtsel != "NONE" || m_evtsel.empty() ) {
57  m_evtSelector = serviceLocator()->service( "EventSelector" );
58  if ( m_evtSelector ) {
59  // Setup Event Selector
61  if ( !sc.isSuccess() ) {
62  fatal() << "Can not create the event selector Context." << endmsg;
63  return sc;
64  }
65  } else {
66  fatal() << "EventSelector not found." << endmsg;
67  return sc;
68  }
69  } else {
70  m_evtSelector = nullptr;
71  m_evtContext = nullptr;
72  if ( m_warnings ) {
73  warning() << "Unable to locate service \"EventSelector\" " << endmsg;
74  warning() << "No events will be processed from external input." << endmsg;
75  }
76  }
77 
78  // Setup access to histogramming services
79  m_histoDataMgrSvc = serviceLocator()->service( "HistogramDataSvc" );
80  if ( !m_histoDataMgrSvc ) {
81  fatal() << "Error retrieving HistogramDataSvc." << endmsg;
82  return sc;
83  }
84  // Setup histogram persistency
85  m_histoPersSvc = serviceLocator()->service( "HistogramPersistencySvc" );
86  if ( !m_histoPersSvc ) {
87  warning() << "Histograms cannot not be saved - though required." << endmsg;
88  return sc;
89  }
90 
91  return StatusCode::SUCCESS;
92 }
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:277
SmartIF< IConversionSvc > m_histoPersSvc
Reference to the Histogram Persistency Service.
Definition: EventLoopMgr.h:54
StatusCode setProperty(const Gaudi::Details::PropertyBase &p) override
set the property form another property
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
Gaudi::Property< bool > m_warnings
Definition: EventLoopMgr.h:41
StatusCode initialize() override
implementation of IService::initialize
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:76
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode createContext(Context *&c) const =0
Create and return a context object that will keep track of the state of selection.
virtual StatusCode getProperty(Gaudi::Details::PropertyBase *p) const =0
Get the property by property.
bool isSuccess() const
Definition: StatusCode.h:267
SmartIF< IDataManagerSvc > m_evtDataMgrSvc
Reference to the Event Data Service's IDataManagerSvc interface.
Definition: EventLoopMgr.h:44
SmartIF< IProperty > m_appMgrProperty
Property interface of ApplicationMgr.
Definition: EventLoopMgr.h:56
IEvtSelector::Context * m_evtContext
Event Iterator.
Definition: EventLoopMgr.h:50
SmartIF< IEvtSelector > m_evtSelector
Reference to the Event Selector.
Definition: EventLoopMgr.h:48
#define DEBMSG
Gaudi::Property< std::string > m_evtsel
Definition: EventLoopMgr.h:40
SmartIF< IDataProviderSvc > m_evtDataSvc
Reference to the Event Data Service's IDataProviderSvc interface.
Definition: EventLoopMgr.h:46
constexpr static const auto FAILURE
Definition: StatusCode.h:86
MsgStream & fatal() const
shortcut for the method msgStream(MSG::FATAL)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
SmartIF< IDataManagerSvc > m_histoDataMgrSvc
Reference to the Histogram Data Service.
Definition: EventLoopMgr.h:52

◆ MinimalEventLoopMgr() [1/2]

MinimalEventLoopMgr::MinimalEventLoopMgr

Standard Constructor.

Definition at line 28 of file MinimalEventLoopMgr.cpp.

29  : base_class( nam, svcLoc ), m_appMgrUI( svcLoc ) {}
extends base_class
Typedef to this class.
Definition: extends.h:14
SmartIF< IAppMgrUI > m_appMgrUI
Reference to the IAppMgrUI interface of the application manager.

◆ MinimalEventLoopMgr() [2/2]

MinimalEventLoopMgr::MinimalEventLoopMgr
delete

No copy allowed.

◆ nextEvent()

StatusCode EventLoopMgr::nextEvent ( int  maxevt)
override

implementation of IEventProcessor::nextEvent

Definition at line 259 of file EventLoopMgr.cpp.

259  {
260 
261  // DP Monitoring
262  // Calculate runtime
264  typedef Clock::time_point time_point;
265 
266  const float oneOver1024 = 1.f / 1024.f;
267 
268  DataObject* pObject = nullptr;
269  StatusCode sc( StatusCode::SUCCESS, true );
270 
271  // loop over events if the maxevt (received as input) if different from -1.
272  // if evtmax is -1 it means infinite loop
273  time_point start_time = Clock::now();
274  for ( int nevt = 0; maxevt == -1 || nevt < maxevt; ++nevt ) {
275 
276  if ( 1 == nevt ) // reset after first evt
277  start_time = Clock::now();
278 
279  auto ctx = createEventContext();
280 
281  // always() << "Event Number = " << total_nevt
282  // << " WSS (MB) = " << System::mappedMemory(System::MemoryUnit::kByte)*oneOver1024
283  // << " Time (s) = " << secsFromStart(start_time) << endmsg;
284 
285  // Check if there is a scheduled stop issued by some algorithm/service
286  if ( m_scheduledStop ) {
287  m_scheduledStop = false;
288  always() << "Terminating event processing loop due to scheduled stop" << endmsg;
289  break;
290  }
291  // Clear the event store, if used in the event loop
292  if ( 0 != ctx.evt() ) {
293 
294  if ( !m_endEventFired ) {
295  // Fire EndEvent "Incident" (it is considered part of the clearing of the TS)
296  m_incidentSvc->fireIncident( Incident( name(), IncidentType::EndEvent ) );
297  m_endEventFired = true;
298  }
299  sc = m_evtDataMgrSvc->clearStore();
300  if ( !sc.isSuccess() ) { DEBMSG << "Clear of Event data store failed" << endmsg; }
301  }
302 
303  // Setup event in the event store
304  if ( m_evtContext ) {
305  IOpaqueAddress* addr = nullptr;
306  // Only if there is a EventSelector
307  sc = getEventRoot( addr );
308  if ( !sc.isSuccess() ) {
309  info() << "No more events in event selection " << endmsg;
310  break;
311  }
312  // Set root clears the event data store first
313  sc = m_evtDataMgrSvc->setRoot( "/Event", addr );
314  if ( !sc.isSuccess() ) {
315  warning() << "Error declaring event root address." << endmsg;
316  continue;
317  }
318  sc = m_evtDataSvc->retrieveObject( "/Event", pObject );
319  if ( !sc.isSuccess() ) {
320  warning() << "Unable to retrieve Event root object" << endmsg;
321  break;
322  }
323  } else {
324  sc = m_evtDataMgrSvc->setRoot( "/Event", new DataObject() );
325  if ( !sc.isSuccess() ) { warning() << "Error declaring event root DataObject" << endmsg; }
326  }
327  // Execute event for all required algorithms
328  sc = executeEvent( std::move( ctx ) );
329  m_endEventFired = false;
330  if ( !sc.isSuccess() ) {
331  error() << "Terminating event processing loop due to errors" << endmsg;
333  return sc;
334  }
335  }
336 
337  if ( UNLIKELY( outputLevel() <= MSG::DEBUG ) )
338  debug() << "---> Loop Finished - "
339  << " WSS " << System::mappedMemory( System::MemoryUnit::kByte ) * oneOver1024
340  << " | total time (skipping 1st evt) "
341  << std::chrono::duration_cast<std::chrono::nanoseconds>( Clock::now() - start_time ).count() << " ns"
342  << endmsg;
343 
344  return StatusCode::SUCCESS;
345 }
#define UNLIKELY(x)
Definition: Kernel.h:96
bool m_scheduledStop
Scheduled stop of event processing.
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
virtual StatusCode setRoot(std::string root_name, DataObject *pObject)=0
Initialize data store for new event by giving new event path.
StatusCode executeEvent(EventContext &&ctx) override
implementation of IEventProcessor::executeEvent(EventContext&&)
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
virtual StatusCode clearStore()=0
Remove all data objects in the data store.
MsgStream & always() const
shortcut for the method msgStream(MSG::ALWAYS)
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
virtual void fireIncident(const Incident &incident)=0
Fire an Incident.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode getEventRoot(IOpaqueAddress *&refpAddr)
Create event address using event selector.
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
SmartIF< IIncidentSvc > m_incidentSvc
Reference to the incident service.
StatusCode setAppReturnCode(SmartIF< IProperty > &appmgr, int value, bool force=false)
Set the application return code.
Definition: AppReturnCode.h:49
T move(T... args)
SmartIF< IDataManagerSvc > m_evtDataMgrSvc
Reference to the Event Data Service's IDataManagerSvc interface.
Definition: EventLoopMgr.h:44
int outputLevel() const
get the Service's output level
Definition: Service.h:158
GAUDI_API long mappedMemory(MemoryUnit unit=kByte, InfoType fetch=Memory, long pid=-1)
Basic Process Information: priority boost.
Definition: Memory.cpp:187
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
virtual StatusCode retrieveObject(IRegistry *pDirectory, std::string_view path, DataObject *&pObject)=0
Retrieve object identified by its directory entry.
SmartIF< IProperty > m_appMgrProperty
Property interface of ApplicationMgr.
Definition: EventLoopMgr.h:56
IEvtSelector::Context * m_evtContext
Event Iterator.
Definition: EventLoopMgr.h:50
#define DEBMSG
Base class for all Incidents (computing events).
Definition: Incident.h:17
constexpr int AlgorithmFailure
Definition: AppReturnCode.h:24
bool m_endEventFired
Flag to avoid to fire the EnvEvent incident twice in a row (and also not before the first event)
Definition: EventLoopMgr.h:59
SmartIF< IDataProviderSvc > m_evtDataSvc
Reference to the Event Data Service's IDataProviderSvc interface.
Definition: EventLoopMgr.h:46
EventContext createEventContext() override
implementation of IEventProcessor::createEventContext()
Opaque address interface definition.
int maxevt
Definition: Bootstrap.cpp:260
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ reinitialize()

StatusCode EventLoopMgr::reinitialize ( )
override

implementation of IService::reinitialize

Definition at line 96 of file EventLoopMgr.cpp.

96  {
97 
98  // Initialize the base class
100  if ( !sc.isSuccess() ) {
101  DEBMSG << "Error Initializing base class MinimalEventLoopMgr." << endmsg;
102  return sc;
103  }
104 
105  // Check to see whether a new Event Selector has been specified
106  setProperty( m_appMgrProperty->getProperty( "EvtSel" ) );
107  if ( m_evtsel != "NONE" || m_evtsel.length() == 0 ) {
108  auto theSvc = serviceLocator()->service<IService>( "EventSelector" );
109  auto theEvtSel = theSvc.as<IEvtSelector>();
110  if ( theEvtSel && ( theEvtSel.get() != m_evtSelector.get() ) ) {
111  // Setup Event Selector
112  if ( m_evtSelector.get() && m_evtContext ) {
113  // Need to release context before switching to new event selector
115  m_evtContext = nullptr;
116  }
117  m_evtSelector = theEvtSel;
118  if ( theSvc->FSMState() == Gaudi::StateMachine::INITIALIZED ) {
119  sc = theSvc->reinitialize();
120  if ( !sc.isSuccess() ) {
121  error() << "Failure Reinitializing EventSelector " << theSvc->name() << endmsg;
122  return sc;
123  }
124  } else {
125  sc = theSvc->sysInitialize();
126  if ( !sc.isSuccess() ) {
127  error() << "Failure Initializing EventSelector " << theSvc->name() << endmsg;
128  return sc;
129  }
130  }
132  if ( !sc.isSuccess() ) {
133  error() << "Can not create Context " << theSvc->name() << endmsg;
134  return sc;
135  }
136  info() << "EventSelector service changed to " << theSvc->name() << endmsg;
137  } else if ( m_evtSelector ) {
138  if ( m_evtContext ) {
140  m_evtContext = nullptr;
141  }
143  if ( !sc.isSuccess() ) {
144  error() << "Can not create Context " << theSvc->name() << endmsg;
145  return sc;
146  }
147  }
148  } else if ( m_evtSelector && m_evtContext ) {
150  m_evtSelector = nullptr;
151  m_evtContext = nullptr;
152  }
153  return StatusCode::SUCCESS;
154 }
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:277
StatusCode setProperty(const Gaudi::Details::PropertyBase &p) override
set the property form another property
The Event Selector Interface.
Definition: IEvtSelector.h:18
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
StatusCode reinitialize() override
implementation of IService::reinitialize
StatusCode service(const Gaudi::Utils::TypeNameString &name, T *&svc, bool createIf=true)
Templated method to access a service by name.
Definition: ISvcLocator.h:76
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
General service interface definition.
Definition: IService.h:18
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode createContext(Context *&c) const =0
Create and return a context object that will keep track of the state of selection.
virtual StatusCode getProperty(Gaudi::Details::PropertyBase *p) const =0
Get the property by property.
virtual StatusCode releaseContext(Context *&) const =0
Release the Context object.
bool isSuccess() const
Definition: StatusCode.h:267
SmartIF< IProperty > m_appMgrProperty
Property interface of ApplicationMgr.
Definition: EventLoopMgr.h:56
IEvtSelector::Context * m_evtContext
Event Iterator.
Definition: EventLoopMgr.h:50
SmartIF< IEvtSelector > m_evtSelector
Reference to the Event Selector.
Definition: EventLoopMgr.h:48
#define DEBMSG
Gaudi::Property< std::string > m_evtsel
Definition: EventLoopMgr.h:40
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ stop()

StatusCode EventLoopMgr::stop ( )
override

implementation of IService::stop

Definition at line 159 of file EventLoopMgr.cpp.

159  {
160  if ( !m_endEventFired ) {
161  // Fire pending EndEvent incident
162  m_incidentSvc->fireIncident( Incident( name(), IncidentType::EndEvent ) );
163  m_endEventFired = true;
164  }
165  return MinimalEventLoopMgr::stop();
166 }
StatusCode stop() override
implementation of IService::stop
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
virtual void fireIncident(const Incident &incident)=0
Fire an Incident.
SmartIF< IIncidentSvc > m_incidentSvc
Reference to the incident service.
Base class for all Incidents (computing events).
Definition: Incident.h:17
bool m_endEventFired
Flag to avoid to fire the EnvEvent incident twice in a row (and also not before the first event)
Definition: EventLoopMgr.h:59

Member Data Documentation

◆ m_appMgrProperty

SmartIF<IProperty> EventLoopMgr::m_appMgrProperty = nullptr
protected

Property interface of ApplicationMgr.

Definition at line 56 of file EventLoopMgr.h.

◆ m_endEventFired

bool EventLoopMgr::m_endEventFired = true
protected

Flag to avoid to fire the EnvEvent incident twice in a row (and also not before the first event)

Definition at line 59 of file EventLoopMgr.h.

◆ m_evtContext

IEvtSelector::Context* EventLoopMgr::m_evtContext = nullptr
protected

Event Iterator.

Definition at line 50 of file EventLoopMgr.h.

◆ m_evtDataMgrSvc

SmartIF<IDataManagerSvc> EventLoopMgr::m_evtDataMgrSvc = nullptr
protected

Reference to the Event Data Service's IDataManagerSvc interface.

Definition at line 44 of file EventLoopMgr.h.

◆ m_evtDataSvc

SmartIF<IDataProviderSvc> EventLoopMgr::m_evtDataSvc = nullptr
protected

Reference to the Event Data Service's IDataProviderSvc interface.

Definition at line 46 of file EventLoopMgr.h.

◆ m_evtsel

Gaudi::Property<std::string> EventLoopMgr::m_evtsel {this, "EvtSel", {}, "event selector"}
protected

Definition at line 40 of file EventLoopMgr.h.

◆ m_evtSelector

SmartIF<IEvtSelector> EventLoopMgr::m_evtSelector = nullptr
protected

Reference to the Event Selector.

Definition at line 48 of file EventLoopMgr.h.

◆ m_histoDataMgrSvc

SmartIF<IDataManagerSvc> EventLoopMgr::m_histoDataMgrSvc = nullptr
protected

Reference to the Histogram Data Service.

Definition at line 52 of file EventLoopMgr.h.

◆ m_histoPersSvc

SmartIF<IConversionSvc> EventLoopMgr::m_histoPersSvc = nullptr
protected

Reference to the Histogram Persistency Service.

Definition at line 54 of file EventLoopMgr.h.

◆ m_histPersName

Gaudi::Property<std::string> EventLoopMgr::m_histPersName {this, "HistogramPersistency", {}, "name of the Hist Pers type"}
protected

Definition at line 39 of file EventLoopMgr.h.

◆ m_warnings

Gaudi::Property<bool> EventLoopMgr::m_warnings {this, "Warnings", true, "set to false to suppress warning messages"}
protected

Definition at line 41 of file EventLoopMgr.h.


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