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 (const std::string &nam, ISvcLocator *svcLoc)
	Standard Constructor. More...
	~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 IService::nextEvent More...
StatusCode	executeEvent (void *par) override
	implementation of IEventProcessor::executeEvent(void* par) More...
Public Member Functions inherited from MinimalEventLoopMgr
	MinimalEventLoopMgr (const std::string &nam, ISvcLocator *svcLoc)
	Standard Constructor. More...
	~MinimalEventLoopMgr () override=default
	Standard Destructor. More...
virtual StatusCode	start ()
	implementation of IService::start More...
virtual StatusCode	restart ()
	implementation of IService::restart More...
virtual StatusCode	executeRun (int maxevt)
	implementation of IEventProcessor::executeRun( ) More...
virtual StatusCode	stopRun ()
	implementation of IEventProcessor::stopRun( ) More...
void	topAlgHandler (Property &p)
	Top algorithm List handler. More...
StatusCode	decodeTopAlgs ()
	decodeTopAlgNameList & topAlgNameListHandler More...
void	outStreamHandler (Property &p)
	Output stream List handler. More...
StatusCode	decodeOutStreams ()
	decodeOutStreamNameList & outStreamNameListHandler More...
	MinimalEventLoopMgr (const std::string &nam, ISvcLocator *svcLoc)
	Standard Constructor. More...
	~MinimalEventLoopMgr () override=default
	Standard Destructor. More...
virtual StatusCode	start ()
	implementation of IService::start More...
virtual StatusCode	restart ()
	implementation of IService::restart More...
virtual StatusCode	executeRun (int maxevt)
	implementation of IEventProcessor::executeRun( ) More...
virtual StatusCode	stopRun ()
	implementation of IEventProcessor::stopRun( ) More...
void	topAlgHandler (Property &p)
	Top algorithm List handler. More...
StatusCode	decodeTopAlgs ()
	decodeTopAlgNameList & topAlgNameListHandler More...
void	outStreamHandler (Property &p)
	Output stream List handler. More...
StatusCode	decodeOutStreams ()
	decodeOutStreamNameList & outStreamNameListHandler More...
Public Member Functions inherited from extends< BASE, Interfaces >
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...
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 extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Attributes
SmartIF< IDataManagerSvc >	m_evtDataMgrSvc = nullptr
	Reference to the Event Data Service's IDataManagerSvc interface. More...
SmartIF< IDataProviderSvc >	m_evtDataSvc = nullptr
	Reference to the Event Data Service's IDataProviderSvc interface. More...
SmartIF< IEvtSelector >	m_evtSelector = nullptr
	Reference to the Event Selector. More...
IEvtSelector::Context *	m_evtContext = nullptr
	Event Iterator. More...
std::string	m_evtsel
	Event selector. More...
SmartIF< IDataManagerSvc >	m_histoDataMgrSvc = nullptr
	Reference to the Histogram Data Service. More...
SmartIF< IConversionSvc >	m_histoPersSvc = nullptr
	Reference to the Histogram Persistency Service. More...
std::string	m_histPersName
	Name of the Hist Pers type. More...
SmartIF< IProperty >	m_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...
bool	m_warnings = true
	Flag to disable warning messages when using external input. More...
Protected Attributes inherited from MinimalEventLoopMgr
SmartIF< IAppMgrUI >	m_appMgrUI
	Reference to the IAppMgrUI interface of the application manager. More...
SmartIF< IIncidentSvc >	m_incidentSvc
	Reference to the incident service. More...
ListAlg	m_topAlgList
	List of top level algorithms. More...
ListAlg	m_outStreamList
	List of output streams. More...
std::string	m_outStreamType
	Out Stream type. More...
StringArrayProperty	m_topAlgNames
	List of top level algorithms names. More...
StringArrayProperty	m_outStreamNames
	List of output stream names. More...
State	m_state = OFFLINE
	State of the object. More...
bool	m_scheduledStop = false
	Scheduled stop of event processing. More...
SmartIF< IIncidentListener >	m_abortEventListener
	Instance of the incident listener waiting for AbortEvent. More...
bool	m_abortEvent = false
	Flag signalling that the event being processedhas to be aborted (skip all following top algs). More...
std::string	m_abortEventSource
	Source of the AbortEvent incident. More...

Additional Inherited Members
Public Types inherited from MinimalEventLoopMgr
typedef std::vector< SmartIF< IAlgorithm > >	ListAlg
typedef std::vector< SmartIF< IAlgorithm > >	ListAlg
Public Types inherited from extends< BASE, Interfaces >
typedef extends	base_class
	Typedef to this class. More...
typedef extend_interfaces< Interfaces...>	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extends	base_class
	Typedef to this class. More...
typedef extend_interfaces< Interfaces...>	extend_interfaces_base
	Typedef to the base of this class. More...
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...
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,   OFFLINE, CONFIGURED, FINALIZED, INITIALIZED }
enum	State {   OFFLINE, CONFIGURED, FINALIZED, INITIALIZED,   OFFLINE, CONFIGURED, FINALIZED, INITIALIZED }

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 38 of file EventLoopMgr.h.

Constructor & Destructor Documentation

EventLoopMgr::EventLoopMgr	(	const std::string &	nam,
		ISvcLocator *	svcLoc
	)

Standard Constructor.

Definition at line 30 of file EventLoopMgr.cpp.

: MinimalEventLoopMgr(nam, svcLoc)
{
  // Declare properties
  declareProperty("HistogramPersistency", m_histPersName );
  declareProperty("EvtSel", m_evtsel );
  declareProperty("Warnings",m_warnings=true,
          "Set this property to false to suppress warning messages");
}

EventLoopMgr::~EventLoopMgr ( )

override

Standard Destructor.

Definition at line 43 of file EventLoopMgr.cpp.

                              {
  delete m_evtContext;
}

Member Function Documentation

StatusCode EventLoopMgr::executeEvent ( void *  par )

overridevirtual

implementation of IEventProcessor::executeEvent(void* par)

Reimplemented from MinimalEventLoopMgr.

Definition at line 268 of file EventLoopMgr.cpp.

                                                  {

  // Fire BeginEvent "Incident"
  m_incidentSvc->fireIncident(Incident(name(),IncidentType::BeginEvent));
  // An incident may schedule a stop, in which case is better to exit before the actual execution.
  if ( m_scheduledStop ) {
    always() << "Terminating event processing loop due to a stop scheduled by an incident listener" << endmsg;
    return StatusCode::SUCCESS;
  }

  // Execute Algorithms
  m_incidentSvc->fireIncident(Incident(name(), IncidentType::BeginProcessing));
  StatusCode sc = MinimalEventLoopMgr::executeEvent(par);
  m_incidentSvc->fireIncident(Incident(name(), IncidentType::EndProcessing));

  // Check if there was an error processing current event
  if( UNLIKELY(!sc.isSuccess()) ){
    error() << "Terminating event processing loop due to errors" << endmsg;
  }
  return sc;
}

StatusCode EventLoopMgr::finalize ( )

overridevirtual

implementation of IService::finalize

Reimplemented from MinimalEventLoopMgr.

Definition at line 202 of file EventLoopMgr.cpp.

                                     {
  StatusCode sc;

  // Finalize base class
  sc = MinimalEventLoopMgr::finalize();
  if (! sc.isSuccess()) {
    error() << "Error finalizing base class" << endmsg;
    return sc;
  }

  // Save Histograms Now
  if ( m_histoPersSvc )    {
    HistogramAgent agent;
    sc = m_histoDataMgrSvc->traverseTree( &agent );
    if( sc.isSuccess() )   {
      IDataSelector* objects = agent.selectedObjects();
      // skip /stat entry!
      if ( objects->size() > 0 )    {
        for ( auto&  i : *objects ) {
          IOpaqueAddress* pAddr = nullptr;
          StatusCode iret = m_histoPersSvc->createRep(i, pAddr);
          if ( iret.isSuccess() )     {
            i->registry()->setAddress(pAddr);
          }
          else  {
            sc = iret;
          }
        }
        for ( auto& i : *objects )    {
          IRegistry* reg = i->registry();
          StatusCode iret = m_histoPersSvc->fillRepRefs(reg->address(), i);
          if ( !iret.isSuccess() ) sc = iret;
        }
      }
      if ( sc.isSuccess() )    {
        info() << "Histograms converted successfully according to request." << endmsg;
      }
      else  {
        error() << "Error while saving Histograms." << endmsg;
      }
    }
    else {
      error() << "Error while traversing Histogram data store" << endmsg;
    }
  }

  // Release event selector context
  if ( m_evtSelector && m_evtContext )   {
    m_evtSelector->releaseContext(m_evtContext).ignore();
    m_evtContext = nullptr;
  }

  // Release all interfaces...
  m_histoDataMgrSvc = nullptr;
  m_histoPersSvc    = nullptr;

  m_evtSelector     = nullptr;
  m_evtDataSvc      = nullptr;
  m_evtDataMgrSvc   = nullptr;

  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::getEventRoot

(

IOpaqueAddress *&

refpAddr

)

Create event address using event selector.

Definition at line 361 of file EventLoopMgr.cpp.

                                                                {
  refpAddr = nullptr;
  StatusCode sc = m_evtSelector->next(*m_evtContext);
  if ( !sc.isSuccess() )  return sc;
  // Create root address and assign address to data service
  sc = m_evtSelector->createAddress(*m_evtContext,refpAddr);
  if( !sc.isSuccess() )  {
    sc = m_evtSelector->next(*m_evtContext);
    if ( sc.isSuccess() )  {
      sc = m_evtSelector->createAddress(*m_evtContext,refpAddr);
      if ( !sc.isSuccess() )  {
        warning() << "Error creating IOpaqueAddress." << endmsg;
      }
    }
  }
  return sc;
}

StatusCode EventLoopMgr::initialize ( )

overridevirtual

implementation of IService::initialize

Reimplemented from MinimalEventLoopMgr.

Definition at line 50 of file EventLoopMgr.cpp.

                                       {
  // Initialize the base class
  StatusCode sc = MinimalEventLoopMgr::initialize();
  if( !sc.isSuccess() ) {
    DEBMSG << "Error Initializing base class MinimalEventLoopMgr." << endmsg;
    return sc;
  }

  // Setup access to event data services
  m_evtDataMgrSvc = serviceLocator()->service("EventDataSvc");
  if( !m_evtDataMgrSvc )  {
    fatal() << "Error retrieving EventDataSvc interface IDataManagerSvc." << endmsg;
    return StatusCode::FAILURE;
  }
  m_evtDataSvc = serviceLocator()->service("EventDataSvc");
  if( !m_evtDataSvc )  {
    fatal() << "Error retrieving EventDataSvc interface IDataProviderSvc." << endmsg;
    return StatusCode::FAILURE;
  }

  // Obtain the IProperty of the ApplicationMgr
  m_appMgrProperty = serviceLocator();
  if ( ! m_appMgrProperty )   {
    fatal() << "IProperty interface not found in ApplicationMgr." << endmsg;
    return StatusCode::FAILURE;
  }

  // We do not expect a Event Selector necessarily being declared
  setProperty(m_appMgrProperty->getProperty("EvtSel")).ignore();

  if( m_evtsel != "NONE" || m_evtsel.length() == 0) {
    m_evtSelector = serviceLocator()->service("EventSelector");
    if( m_evtSelector ) {
      // Setup Event Selector
      sc=m_evtSelector->createContext(m_evtContext);
      if( !sc.isSuccess() )   {
        fatal() << "Can not create the event selector Context." << endmsg;
        return sc;
      }
    }
    else {
      fatal() << "EventSelector not found." << endmsg;
      return sc;
    }
  } else {
    m_evtSelector = nullptr;
    m_evtContext = nullptr;
    if ( m_warnings ) {
      warning() << "Unable to locate service \"EventSelector\" " << endmsg;
      warning() << "No events will be processed from external input." << endmsg;
    }
  }

  // Setup access to histogramming services
  m_histoDataMgrSvc = serviceLocator()->service("HistogramDataSvc");
  if( !m_histoDataMgrSvc )  {
    fatal() << "Error retrieving HistogramDataSvc." << endmsg;
    return sc;
  }
  // Setup histogram persistency
  m_histoPersSvc = serviceLocator()->service("HistogramPersistencySvc");
  if( !m_histoPersSvc ) {
    warning() << "Histograms cannot not be saved - though required." << endmsg;
    return sc;
  }

  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::nextEvent ( int  maxevt )

overridevirtual

implementation of IService::nextEvent

Reimplemented from MinimalEventLoopMgr.

Definition at line 293 of file EventLoopMgr.cpp.

                                               {
  static int        total_nevt = 0;
  DataObject*       pObject = nullptr;
  StatusCode        sc(StatusCode::SUCCESS, true);

  // loop over events if the maxevt (received as input) if different from -1.
  // if evtmax is -1 it means infinite loop
  for( int nevt = 0; maxevt == -1 || nevt < maxevt;  ++nevt, ++total_nevt) {

    // Check if there is a scheduled stop issued by some algorithm/service
    if ( m_scheduledStop ) {
      m_scheduledStop = false;
      always() << "Terminating event processing loop due to scheduled stop" << endmsg;
      break;
    }
    // Clear the event store, if used in the event loop
    if( 0 != total_nevt ) {

      if ( ! m_endEventFired ) {
        // Fire EndEvent "Incident" (it is considered part of the clearing of the TS)
        m_incidentSvc->fireIncident(Incident(name(),IncidentType::EndEvent));
        m_endEventFired = true;
      }
      sc = m_evtDataMgrSvc->clearStore();
      if( !sc.isSuccess() )  {
        DEBMSG << "Clear of Event data store failed" << endmsg;
      }
    }

    // Setup event in the event store
    if( m_evtContext ) {
      IOpaqueAddress* addr = nullptr;
      // Only if there is a EventSelector
      sc = getEventRoot(addr);
      if( !sc.isSuccess() )  {
        info() << "No more events in event selection " << endmsg;
        break;
      }
      // Set root clears the event data store first
      sc = m_evtDataMgrSvc->setRoot ("/Event", addr);
      if( !sc.isSuccess() )  {
        warning() << "Error declaring event root address." << endmsg;
        continue;
      }
      sc = m_evtDataSvc->retrieveObject("/Event", pObject);
      if( !sc.isSuccess() ) {
        warning() << "Unable to retrieve Event root object" << endmsg;
        break;
      }
    } else {
      sc = m_evtDataMgrSvc->setRoot ("/Event", new DataObject());
      if( !sc.isSuccess() )  {
        warning() << "Error declaring event root DataObject" << endmsg;
      }
    }
    // Execute event for all required algorithms
    sc = executeEvent(nullptr);
    m_endEventFired = false;
    if( !sc.isSuccess() ){
      error() << "Terminating event processing loop due to errors" << endmsg;
      Gaudi::setAppReturnCode(m_appMgrProperty, Gaudi::ReturnCode::AlgorithmFailure).ignore();
      return sc;
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::reinitialize ( )

overridevirtual

implementation of IService::reinitialize

Reimplemented from MinimalEventLoopMgr.

Definition at line 121 of file EventLoopMgr.cpp.

                                      {

  // Initialize the base class
  StatusCode sc = MinimalEventLoopMgr::reinitialize();
  if( !sc.isSuccess() ) {
    DEBMSG << "Error Initializing base class MinimalEventLoopMgr." << endmsg;
    return sc;
  }

  // Check to see whether a new Event Selector has been specified
  setProperty(m_appMgrProperty->getProperty("EvtSel"));
  if( m_evtsel != "NONE" || m_evtsel.length() == 0) {
    auto theSvc = serviceLocator()->service<IService>("EventSelector");
    auto theEvtSel = theSvc.as<IEvtSelector>();
    if( theEvtSel && ( theEvtSel.get() != m_evtSelector.get() ) ) {
      // Setup Event Selector
      if ( m_evtSelector.get() && m_evtContext ) {
        // Need to release context before switching to new event selector
        m_evtSelector->releaseContext(m_evtContext);
        m_evtContext = nullptr;
      }
      m_evtSelector = theEvtSel;
      if (theSvc->FSMState() == Gaudi::StateMachine::INITIALIZED) {
        sc = theSvc->reinitialize();
        if( !sc.isSuccess() ) {
          error() << "Failure Reinitializing EventSelector "
                  << theSvc->name( ) << endmsg;
          return sc;
        }
      } else {
        sc = theSvc->sysInitialize();
        if( !sc.isSuccess() ) {
          error() << "Failure Initializing EventSelector "
                  << theSvc->name( ) << endmsg;
          return sc;
        }
      }
      sc = m_evtSelector->createContext(m_evtContext);
      if( !sc.isSuccess() ) {
        error() << "Can not create Context " << theSvc->name( ) << endmsg;
        return sc;
      }
      info() << "EventSelector service changed to "
             << theSvc->name( ) << endmsg;
    }
    else if ( m_evtSelector ) {
      if ( m_evtContext ) {
        m_evtSelector->releaseContext(m_evtContext);
        m_evtContext = nullptr;
      }
      sc = m_evtSelector->createContext(m_evtContext);
      if( !sc.isSuccess() ) {
        error() << "Can not create Context " << theSvc->name( ) << endmsg;
        return sc;
      }
    }
  }
  else if ( m_evtSelector && m_evtContext ) {
    m_evtSelector->releaseContext(m_evtContext);
    m_evtSelector = nullptr;
    m_evtContext = nullptr;
  }
  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::stop ( )

overridevirtual

implementation of IService::stop

Reimplemented from MinimalEventLoopMgr.

Definition at line 190 of file EventLoopMgr.cpp.

                                 {
  if ( ! m_endEventFired ) {
    // Fire pending EndEvent incident
    m_incidentSvc->fireIncident(Incident(name(),IncidentType::EndEvent));
    m_endEventFired = true;
  }
  return MinimalEventLoopMgr::stop();
}

Member Data Documentation

SmartIF<IProperty> EventLoopMgr::m_appMgrProperty = nullptr

protected

Property interface of ApplicationMgr.

Definition at line 59 of file EventLoopMgr.h.

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 62 of file EventLoopMgr.h.

IEvtSelector::Context* EventLoopMgr::m_evtContext = nullptr

protected

Event Iterator.

Definition at line 49 of file EventLoopMgr.h.

SmartIF<IDataManagerSvc> EventLoopMgr::m_evtDataMgrSvc = nullptr

protected

Reference to the Event Data Service's IDataManagerSvc interface.

Definition at line 43 of file EventLoopMgr.h.

SmartIF<IDataProviderSvc> EventLoopMgr::m_evtDataSvc = nullptr

protected

Reference to the Event Data Service's IDataProviderSvc interface.

Definition at line 45 of file EventLoopMgr.h.

std::string EventLoopMgr::m_evtsel

protected

Event selector.

Definition at line 51 of file EventLoopMgr.h.

SmartIF<IEvtSelector> EventLoopMgr::m_evtSelector = nullptr

protected

Reference to the Event Selector.

Definition at line 47 of file EventLoopMgr.h.

SmartIF<IDataManagerSvc> EventLoopMgr::m_histoDataMgrSvc = nullptr

protected

Reference to the Histogram Data Service.

Definition at line 53 of file EventLoopMgr.h.

SmartIF<IConversionSvc> EventLoopMgr::m_histoPersSvc = nullptr

protected

Reference to the Histogram Persistency Service.

Definition at line 55 of file EventLoopMgr.h.

std::string EventLoopMgr::m_histPersName

protected

Name of the Hist Pers type.

Definition at line 57 of file EventLoopMgr.h.

bool EventLoopMgr::m_warnings = true

protected

Flag to disable warning messages when using external input.

Definition at line 64 of file EventLoopMgr.h.

---

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

• GaudiCoreSvc/src/ApplicationMgr/EventLoopMgr.h
• GaudiCoreSvc/src/ApplicationMgr/EventLoopMgr.cpp