Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

EventLoopMgr Class Reference

#include <EventLoopMgr.h>

Inheritance diagram for EventLoopMgr:

[legend]Collaboration diagram for EventLoopMgr:

[legend]List of all members.

---

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

Public Member Functions
	EventLoopMgr (const std::string &nam, ISvcLocator *svcLoc)
	Standard Constructor.
virtual	~EventLoopMgr ()
	Standard Destructor.
StatusCode	getEventRoot (IOpaqueAddress *&refpAddr)
	Create event address using event selector.
virtual StatusCode	initialize ()
	implementation of IService::initalize
virtual StatusCode	reinitialize ()
	implementation of IService::reinitalize
virtual StatusCode	stop ()
	implementation of IService::stop
virtual StatusCode	finalize ()
	implementation of IService::finalize
virtual StatusCode	nextEvent (int maxevt)
	implementation of IService::nextEvent
virtual StatusCode	executeEvent (void *par)
	implementation of IEventProcessor::executeEvent(void* par)
virtual StatusCode	executeRun (int maxevt)
	implementation of IEventProcessor::executeRun()
Protected Attributes
IDataManagerSvc *	m_evtDataMgrSvc
	Reference to the Event Data Service's IDataManagerSvc interface.
IDataProviderSvc *	m_evtDataSvc
	Reference to the Event Data Service's IDataProviderSvc interface.
IEvtSelector *	m_evtSelector
	Reference to the Event Selector.
IEvtSelector::Context *	m_evtContext
	Event Iterator.
std::string	m_evtsel
	Event selector.
IDataManagerSvc *	m_histoDataMgrSvc
	Reference to the Histogram Data Service.
IConversionSvc *	m_histoPersSvc
	Reference to the Histogram Persistency Service.
std::string	m_histPersName
	Name of the Hist Pers type.
IProperty *	m_appMgrProperty
	Property interface of ApplicationMgr.
bool	m_endEventFired
	Flag to avoid to fire the EnvEvent incident twice in a row (and also not before the first event).

---

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 24 of file EventLoopMgr.cpp.

: MinimalEventLoopMgr(nam, svcLoc)
{
  m_histoDataMgrSvc   = 0;
  m_histoPersSvc      = 0;
  m_evtDataMgrSvc     = 0;
  m_evtDataSvc        = 0;
  m_evtSelector       = 0;
  m_evtContext        = 0;
  m_endEventFired     = true;
  
  // Declare properties
  declareProperty("HistogramPersistency", m_histPersName = "");
  declareProperty( "EvtSel", m_evtsel );
}

EventLoopMgr::~EventLoopMgr

(

)

[virtual]

Standard Destructor.

Definition at line 43 of file EventLoopMgr.cpp.

References m_evtContext, m_evtDataMgrSvc, m_evtDataSvc, m_evtSelector, m_histoDataMgrSvc, m_histoPersSvc, and IInterface::release().

                              {
  if( m_histoDataMgrSvc ) m_histoDataMgrSvc->release();
  if( m_histoPersSvc ) m_histoPersSvc->release();
  if( m_evtDataMgrSvc ) m_evtDataMgrSvc->release();
  if( m_evtDataSvc ) m_evtDataSvc->release();
  if( m_evtSelector ) m_evtSelector->release();
  if( m_evtContext ) delete m_evtContext;
}

---

Member Function Documentation

StatusCode EventLoopMgr::getEventRoot

(

IOpaqueAddress *&

refpAddr

)

Create event address using event selector.

Definition at line 383 of file EventLoopMgr.cpp.

References IEvtSelector::createAddress(), endreq(), StatusCode::isSuccess(), m_evtContext, m_evtSelector, Service::msgSvc(), Service::name(), IEvtSelector::next(), and MSG::WARNING.

Referenced by nextEvent().

                                                                {
  refpAddr = 0;
  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() )  {
        MsgStream log( msgSvc(), name() );
        log << MSG::WARNING << "Error creating IOpaqueAddress." << endreq;
      }
    }
  }
  return sc;
}

StatusCode EventLoopMgr::initialize

(

)

[virtual]

implementation of IService::initalize

Reimplemented from MinimalEventLoopMgr.

Definition at line 55 of file EventLoopMgr.cpp.

References IEvtSelector::createContext(), MSG::DEBUG, endreq(), StatusCode::FAILURE, MSG::FATAL, IProperty::getProperty(), IID_IProperty, MinimalEventLoopMgr::initialize(), StatusCode::isSuccess(), SmartIFBase< TYPE >::isValid(), std::basic_string< _CharT, _Traits, _Alloc >::length(), m_appMgrProperty, m_evtContext, m_evtDataMgrSvc, m_evtDataSvc, m_evtsel, m_evtSelector, m_histoDataMgrSvc, m_histoPersSvc, Service::msgSvc(), Service::name(), ISvcLocator::service(), Service::serviceLocator(), Service::setProperty(), StatusCode::SUCCESS, and MSG::WARNING.

                                       {
  MsgStream log(msgSvc(), name());

  // initilaize the base class
  StatusCode sc = MinimalEventLoopMgr::initialize();
  if( !sc.isSuccess() ) {
    log << MSG::DEBUG << "Error Initializing base class MinimalEventLoopMgr." << endreq;
    return sc;
  }

  // Setup access to event data services
  sc = serviceLocator()->service("EventDataSvc", m_evtDataMgrSvc, true);
  if( !sc.isSuccess() )  {
    log << MSG::FATAL << "Error retrieving EventDataSvc interface IDataManagerSvc." << endreq;
    return sc;
  }
  sc = serviceLocator()->service("EventDataSvc", m_evtDataSvc, true);
  if( !sc.isSuccess() )  {
    log << MSG::FATAL << "Error retrieving EventDataSvc interface IDataProviderSvc." << endreq;
    return sc;
  }

  // Obtain the IProperty of the ApplicationMgr
  SmartIF<IProperty> prpMgr(IID_IProperty, serviceLocator());
  if ( ! prpMgr.isValid() )   {
    log << MSG::FATAL << "IProperty interface not found in ApplicationMgr." << endreq;
    return StatusCode::FAILURE;
  }
  else {
    m_appMgrProperty = prpMgr;
  }

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

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

  // Setup access to histogramming services
  sc = serviceLocator()->service("HistogramDataSvc", m_histoDataMgrSvc, true);
  if( !sc.isSuccess() )  {
    log << MSG::FATAL << "Error retrieving HistogramDataSvc." << endreq;
    return sc;
  }
  // Setup histogram persistency
  sc = serviceLocator()->service("HistogramPersistencySvc", m_histoPersSvc, true );
  if( !sc.isSuccess() ) {
    log << MSG::WARNING << "Histograms cannot not be saved - though required." << endreq;
    return sc;
  }
  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::reinitialize

(

)

[virtual]

implementation of IService::reinitalize

Reimplemented from MinimalEventLoopMgr.

Definition at line 129 of file EventLoopMgr.cpp.

References IEvtSelector::createContext(), MSG::DEBUG, endreq(), MSG::ERROR, IService::FSMState(), IProperty::getProperty(), MSG::INFO, Gaudi::StateMachine::INITIALIZED, StatusCode::isSuccess(), std::basic_string< _CharT, _Traits, _Alloc >::length(), m_appMgrProperty, m_evtContext, m_evtsel, m_evtSelector, Service::msgSvc(), INamedInterface::name(), Service::name(), IService::reinitialize(), MinimalEventLoopMgr::reinitialize(), IEvtSelector::releaseContext(), ISvcLocator::service(), Service::serviceLocator(), Service::setProperty(), StatusCode::SUCCESS, and IService::sysInitialize().

                                      {
  MsgStream log(msgSvc(), name());
  
  // initilaize the base class
  StatusCode sc = MinimalEventLoopMgr::reinitialize();
  if( !sc.isSuccess() ) {
    log << MSG::DEBUG << "Error Initializing base class MinimalEventLoopMgr." << endreq;
    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) {
    IEvtSelector* theEvtSel;
    IService*     theSvc;
    sc = serviceLocator()->service( "EventSelector", theEvtSel );
    sc = serviceLocator()->service( "EventSelector", theSvc );
    if( sc.isSuccess() && ( theEvtSel != m_evtSelector ) ) {
      // Setup Event Selector
      m_evtSelector = theEvtSel;
      if (theSvc->FSMState() == Gaudi::StateMachine::INITIALIZED) {
        sc = theSvc->reinitialize();
        if( !sc.isSuccess() ) {
          log << MSG::ERROR << "Failure Reinitializing EventSelector "
              << theSvc->name( ) << endreq;
          return sc;
        }
      } 
      else {
        sc = theSvc->sysInitialize();
        if( !sc.isSuccess() ) {
          log << MSG::ERROR << "Failure Initializing EventSelector "
              << theSvc->name( ) << endreq;
          return sc;
        }
      }
      sc = m_evtSelector->createContext(m_evtContext);
      if( !sc.isSuccess() ) {
        log << MSG::ERROR << "Can not create Context "
            << theSvc->name( ) << endreq;
        return sc;
      }
      log << MSG::INFO << "EventSelector service changed to "
          << theSvc->name( ) << endreq;
    }
    else if ( m_evtSelector && m_evtContext )   {
      m_evtSelector->releaseContext(m_evtContext);
      m_evtContext = 0;
      sc = m_evtSelector->createContext(m_evtContext);
      if( !sc.isSuccess() ) {
        log << MSG::ERROR << "Can not create Context "
            << theSvc->name( ) << endreq;
        return sc;
      }
    }
  }
  else if ( m_evtSelector && m_evtContext )   {
    m_evtSelector->releaseContext(m_evtContext);
    m_evtSelector = 0;
    m_evtContext = 0;
  }
  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::stop

(

)

[virtual]

implementation of IService::stop

Reimplemented from MinimalEventLoopMgr.

Definition at line 197 of file EventLoopMgr.cpp.

References IncidentType::EndEvent, IIncidentSvc::fireIncident(), m_endEventFired, MinimalEventLoopMgr::m_incidentSvc, Service::name(), and MinimalEventLoopMgr::stop().

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

StatusCode EventLoopMgr::finalize

(

)

[virtual]

implementation of IService::finalize

Reimplemented from MinimalEventLoopMgr.

Definition at line 209 of file EventLoopMgr.cpp.

References IConverter::createRep(), endreq(), MSG::ERROR, IConverter::fillRepRefs(), MinimalEventLoopMgr::finalize(), StatusCode::ignore(), MSG::INFO, StatusCode::isSuccess(), m_evtContext, m_evtDataMgrSvc, m_evtDataSvc, m_evtSelector, m_histoDataMgrSvc, m_histoPersSvc, Service::msgSvc(), Service::name(), IEvtSelector::releaseContext(), MinimalEventLoopMgr::releaseInterface(), HistogramAgent::selectedObjects(), StatusCode::SUCCESS, and IDataManagerSvc::traverseTree().

                                     {
  StatusCode sc;
  MsgStream log(msgSvc(), name());
  
  // Finalize base class
  sc = MinimalEventLoopMgr::finalize();
  if (! sc.isSuccess()) {
    log << MSG::ERROR << "Error finalizing base class" << endreq;
    return sc;
  }

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

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

  // Release all interfaces...
  m_histoDataMgrSvc = releaseInterface(m_histoDataMgrSvc);
  m_histoPersSvc    = releaseInterface(m_histoPersSvc);

  m_evtSelector     = releaseInterface(m_evtSelector);
  m_evtDataSvc      = releaseInterface(m_evtDataSvc);
  m_evtDataMgrSvc   = releaseInterface(m_evtDataMgrSvc);

  return StatusCode::SUCCESS;
}

StatusCode EventLoopMgr::nextEvent

(

int

maxevt

)

[virtual]

implementation of IService::nextEvent

Reimplemented from MinimalEventLoopMgr.

Definition at line 315 of file EventLoopMgr.cpp.

References MSG::ALWAYS, IDataManagerSvc::clearStore(), MSG::DEBUG, IncidentType::EndEvent, endreq(), MSG::ERROR, executeEvent(), IIncidentSvc::fireIncident(), getEventRoot(), MSG::INFO, StatusCode::isSuccess(), m_endEventFired, m_evtContext, m_evtDataMgrSvc, m_evtDataSvc, MinimalEventLoopMgr::m_incidentSvc, MinimalEventLoopMgr::m_scheduledStop, Service::msgSvc(), Service::name(), IDataProviderSvc::retrieveObject(), IDataManagerSvc::setRoot(), StatusCode::SUCCESS, and MSG::WARNING.

                                               {
  static int        total_nevt = 0;
  DataObject*       pObject = 0;
  StatusCode        sc;
  MsgStream         log( msgSvc(), name() );

  // 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 ? true : nevt < maxevt);  nevt++, total_nevt++) {
    // Check if there is a scheduled stop issued by some algorithm/sevice
    if ( m_scheduledStop ) {
      m_scheduledStop = false;
      log << MSG::ALWAYS << "Terminating event processing loop due to scheduled stop" << endreq;
      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 clearsing of the TS)
        m_incidentSvc->fireIncident(Incident(name(),IncidentType::EndEvent));
        m_endEventFired = true;
      }
      sc = m_evtDataMgrSvc->clearStore();
      if( !sc.isSuccess() )  {
        log << MSG::DEBUG << "Clear of Event data store failed" << endreq;
      }
    }

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

StatusCode EventLoopMgr::executeEvent

(

void *

par

)

[virtual]

implementation of IEventProcessor::executeEvent(void* par)

Reimplemented from MinimalEventLoopMgr.

Definition at line 280 of file EventLoopMgr.cpp.

References MSG::ALWAYS, IncidentType::BeginEvent, endreq(), MSG::ERROR, MinimalEventLoopMgr::executeEvent(), IIncidentSvc::fireIncident(), StatusCode::isSuccess(), MinimalEventLoopMgr::m_incidentSvc, MinimalEventLoopMgr::m_scheduledStop, Service::msgSvc(), Service::name(), and StatusCode::SUCCESS.

Referenced by nextEvent().

                                                  {

  // 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 ) {
    MsgStream  log( msgSvc(), name() );
    log << MSG::ALWAYS << "Terminating event processing loop due to a stop scheduled by an incident listener" << endreq;
    return StatusCode::SUCCESS;
  }

  // Execute Algorithms
  StatusCode sc = MinimalEventLoopMgr::executeEvent(par);

  // Check if there was an error processing current event
  if( !sc.isSuccess() ){
    MsgStream log( msgSvc(), name() );
    log << MSG::ERROR << "Terminating event processing loop due to errors" << endreq;
  }
  return sc;
}

StatusCode EventLoopMgr::executeRun

(

int

maxevt

)

[virtual]

implementation of IEventProcessor::executeRun()

Reimplemented from MinimalEventLoopMgr.

Definition at line 305 of file EventLoopMgr.cpp.

References MinimalEventLoopMgr::executeRun().

                                                   {
  StatusCode  sc;
  // initialize the base class
  sc = MinimalEventLoopMgr::executeRun(maxevt);
  return sc;
}

---

Member Data Documentation

IDataManagerSvc* EventLoopMgr::m_evtDataMgrSvc [protected]

Reference to the Event Data Service's IDataManagerSvc interface.

Definition at line 41 of file EventLoopMgr.h.

Referenced by finalize(), initialize(), nextEvent(), and ~EventLoopMgr().

IDataProviderSvc* EventLoopMgr::m_evtDataSvc [protected]

Reference to the Event Data Service's IDataProviderSvc interface.

Definition at line 43 of file EventLoopMgr.h.

Referenced by finalize(), initialize(), nextEvent(), and ~EventLoopMgr().

IEvtSelector* EventLoopMgr::m_evtSelector [protected]

Reference to the Event Selector.

Definition at line 45 of file EventLoopMgr.h.

Referenced by finalize(), getEventRoot(), initialize(), reinitialize(), and ~EventLoopMgr().

IEvtSelector::Context* EventLoopMgr::m_evtContext [protected]

Event Iterator.

Definition at line 47 of file EventLoopMgr.h.

Referenced by finalize(), getEventRoot(), initialize(), nextEvent(), reinitialize(), and ~EventLoopMgr().

std::string EventLoopMgr::m_evtsel [protected]

Event selector.

Definition at line 49 of file EventLoopMgr.h.

Referenced by initialize(), and reinitialize().

IDataManagerSvc* EventLoopMgr::m_histoDataMgrSvc [protected]

Reference to the Histogram Data Service.

Definition at line 51 of file EventLoopMgr.h.

Referenced by finalize(), initialize(), and ~EventLoopMgr().

IConversionSvc* EventLoopMgr::m_histoPersSvc [protected]

Reference to the Histogram Persistency Service.

Definition at line 53 of file EventLoopMgr.h.

Referenced by finalize(), initialize(), and ~EventLoopMgr().

std::string EventLoopMgr::m_histPersName [protected]

Name of the Hist Pers type.

Definition at line 55 of file EventLoopMgr.h.

IProperty* EventLoopMgr::m_appMgrProperty [protected]

Property interface of ApplicationMgr.

Definition at line 57 of file EventLoopMgr.h.

Referenced by initialize(), and reinitialize().

bool EventLoopMgr::m_endEventFired [protected]

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

Definition at line 60 of file EventLoopMgr.h.

Referenced by nextEvent(), and stop().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/ApplicationMgr/EventLoopMgr.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/ApplicationMgr/EventLoopMgr.cpp

---