MakeEventStreamInfo Class Reference

This class provides an algorithm to make the EventStreamInfo object and update it. More...

#include <MakeEventStreamInfo.h>

Inheritance diagram for MakeEventStreamInfo:

Collaboration diagram for MakeEventStreamInfo:

Public Member Functions
	MakeEventStreamInfo (const std::string &type, const std::string &name, const IInterface *parent)
	Standard AlgTool Constructor.
virtual	~MakeEventStreamInfo ()=default
	Destructor.
virtual StatusCode	initialize () override
	Required of all IAthenaOutputTools: Called by AthenaOutputStream::initialize() (via ToolSvc retrieve()).
virtual StatusCode	postInitialize () override
	Called at the end of AthenaOutputStream::initialize().
virtual StatusCode	preExecute () override
	Called at the beginning of AthenaOutputStream::execute().
virtual StatusCode	preStream () override
	Called before actually streaming objects.
virtual StatusCode	postExecute () override
	Called at the end of AthenaOutputStream::execute().
virtual StatusCode	preFinalize () override
	Called at the beginning of AthenaOutputStream::finalize().
virtual StatusCode	finalize () override
	Called at the end of AthenaOutputStream::finalize() (via release()).

Private Attributes
Gaudi::Property< std::string >	m_dataHeaderKey {this, "DataHeaderKey", "", "name of the data header key"}
	Name of DataHeader key.
Gaudi::Property< std::string >	m_key {this, "Key", "", "name of the EventStreamInfo object"}
	Key, the StoreGate key for the EventStreamInfo object.
Gaudi::Property< std::string >	m_eventInfoKey {this, "EventInfoKey", "EventInfo", "name of the xAOD::EventInfo"}
	Key, the StoreGate key for the xAOD::EventInfo object.
ServiceHandle< IAthMetaDataSvc >	m_metaDataSvc {this, "MetaDataSvc", "MetaDataSvc"}
	Pointer to the data stores.
ServiceHandle< StoreGateSvc >	m_eventStore {this, "StoreGateSvc", "StoreGateSvc"}
std::atomic< unsigned int >	m_eventCounter {0}
	Counter of the events in the stream.

Detailed Description

This class provides an algorithm to make the EventStreamInfo object and update it.

Definition at line 27 of file MakeEventStreamInfo.h.

Constructor & Destructor Documentation

MakeEventStreamInfo()

MakeEventStreamInfo::MakeEventStreamInfo	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard AlgTool Constructor.

Definition at line 20 of file MakeEventStreamInfo.cxx.

                              : base_class(type, name, parent)
{
}

~MakeEventStreamInfo()

virtual MakeEventStreamInfo::~MakeEventStreamInfo ( )

virtualdefault

Destructor.

Member Function Documentation

finalize()

StatusCode MakeEventStreamInfo::finalize ( )

overridevirtual

Called at the end of AthenaOutputStream::finalize() (via release()).

Definition at line 139 of file MakeEventStreamInfo.cxx.

                                         {
   ATH_MSG_DEBUG("in finalize()");
   return StatusCode::SUCCESS;
}

initialize()

StatusCode MakeEventStreamInfo::initialize ( )

overridevirtual

Required of all IAthenaOutputTools: Called by AthenaOutputStream::initialize() (via ToolSvc retrieve()).

Definition at line 26 of file MakeEventStreamInfo.cxx.

                                           {
   ATH_MSG_DEBUG("Initializing " << name());
   // Locate the MetaDataStore
   ATH_CHECK(m_metaDataSvc.retrieve());
   ATH_CHECK(m_eventStore.retrieve());
 
   // Autoconfigure data header key
   if (m_dataHeaderKey.empty()){
      if (const auto* parentAlg = dynamic_cast<const IAlgorithm*>(this->parent()); parentAlg) {
         m_dataHeaderKey.setValue(parentAlg->name());
      } else {
         ATH_MSG_ERROR("Unable to get parent Algorithm");
         return StatusCode::FAILURE;
      }
   }
 
   return StatusCode::SUCCESS;
}

postExecute()

StatusCode MakeEventStreamInfo::postExecute ( )

overridevirtual

Called at the end of AthenaOutputStream::execute().

Definition at line 63 of file MakeEventStreamInfo.cxx.

                                            {
   SG::ReadHandle<DataHeader> dataHeader(m_dataHeaderKey);
   if (!dataHeader.isValid()) {
      return StatusCode::SUCCESS;
   }
   // Retrieve the EventInfo object
   EventType evtype;
   unsigned long long runN = 0;
   unsigned lumiN = 0;
   SG::ReadHandle<xAOD::EventInfo> xEventInfo(m_eventInfoKey);
   if (xEventInfo.isValid()) {
      runN = xEventInfo->runNumber();
      lumiN = xEventInfo->lumiBlock();
      evtype = eventTypeFromxAOD(xEventInfo.get());
   } else {
      ATH_MSG_ERROR("Unable to retrieve xAOD::EventInfo object");
      return StatusCode::FAILURE;
   }
 
   EventStreamInfo* pEventStream = m_metaDataSvc->tryRetrieve<EventStreamInfo>(m_key.value());
   if( !pEventStream ) {
      auto esinfo_up = std::make_unique<EventStreamInfo>();
      pEventStream = esinfo_up.get();
      if( m_metaDataSvc->record(std::move(esinfo_up), m_key.value()).isFailure() ) {
         ATH_MSG_ERROR("Could not register EventStreamInfo object");
         return StatusCode::FAILURE;
      }
   }
   static std::once_flag resetNumberOfEventsFlag;
   std::call_once(resetNumberOfEventsFlag, [this, pEventStream]() -> void {
      ATH_MSG_DEBUG("Resetting the EventStreamInfo payload at the first event");
      pEventStream->reset();
   });
   pEventStream->addEvent();
   pEventStream->insertProcessingTag(dataHeader->getProcessTag());
   pEventStream->insertLumiBlockNumber( lumiN );
   pEventStream->insertRunNumber( runN );
   for (const DataHeaderElement& dhe : *dataHeader) {
      pEventStream->insertItemList(dhe.getPrimaryClassID(), dhe.getKey());
   }
   pEventStream->insertEventType( evtype );
 
   m_eventCounter++;
 
   return StatusCode::SUCCESS;
}

postInitialize()

StatusCode MakeEventStreamInfo::postInitialize ( )

overridevirtual

Called at the end of AthenaOutputStream::initialize().

Definition at line 45 of file MakeEventStreamInfo.cxx.

                                               {
   // Remove EventStreamInfo with same key if it exists
   bool ignoreIfAbsent = true;
   if( !m_metaDataSvc->remove<EventStreamInfo>(m_key.value(), ignoreIfAbsent).isSuccess() ) {
      ATH_MSG_ERROR("Unable to remove EventStreamInfo with key " << m_key.value());
      return StatusCode::FAILURE;
   }
   return StatusCode::SUCCESS;
}

preExecute()

StatusCode MakeEventStreamInfo::preExecute ( )

overridevirtual

Called at the beginning of AthenaOutputStream::execute().

Definition at line 55 of file MakeEventStreamInfo.cxx.

                                           {
   return StatusCode::SUCCESS;
}

preFinalize()

StatusCode MakeEventStreamInfo::preFinalize ( )

overridevirtual

Called at the beginning of AthenaOutputStream::finalize().

Definition at line 110 of file MakeEventStreamInfo.cxx.

                                            {
  EventStreamInfo* pEventStream = m_metaDataSvc->tryRetrieve<EventStreamInfo>(m_key.value());
  if (!pEventStream) {
    auto esinfo_up = std::make_unique<EventStreamInfo>();
    pEventStream = esinfo_up.get();
    ATH_CHECK(m_metaDataSvc->record(std::move(esinfo_up), m_key.value()));
  }
  if (m_eventCounter > 0 &&
      m_eventCounter < pEventStream->getNumberOfEvents()) {
    // The number of events that have been processed by MakeEventStreamInfo
    // tool is less than the number of events in already existing
    // EventStreamInfo object. This can happen if the EventStreamInfo object was
    // updated by CopyEventStreamInfo, for example at beginning of reading the
    // 2nd (or next) file.
    ATH_MSG_DEBUG(
        "Event count mismatch in EventStreamInfo (likely due to "
        "multi-file processing). MakeEventStreamInfo processed: "
        << m_eventCounter << " events, existing EventStreamInfo object has "
        << pEventStream->getNumberOfEvents()
        << " events. Setting number of events to what "
           "MakeEventStreamInfo processed.");
    pEventStream->setNumberOfEvents(m_eventCounter);
  } else {
    // Insert processing tags when no events have been processed
    pEventStream->insertProcessingTag(m_dataHeaderKey.value());
  }
  return (StatusCode::SUCCESS);
}

preStream()

StatusCode MakeEventStreamInfo::preStream ( )

overridevirtual

Called before actually streaming objects.

Definition at line 59 of file MakeEventStreamInfo.cxx.

                                          {
   return StatusCode::SUCCESS;
}

Member Data Documentation

m_dataHeaderKey

Gaudi::Property<std::string> MakeEventStreamInfo::m_dataHeaderKey {this, "DataHeaderKey", "", "name of the data header key"}

private

Name of DataHeader key.

Definition at line 51 of file MakeEventStreamInfo.h.

{this, "DataHeaderKey", "", "name of the data header key"};

m_eventCounter

std::atomic<unsigned int> MakeEventStreamInfo::m_eventCounter {0}

private

Counter of the events in the stream.

Definition at line 63 of file MakeEventStreamInfo.h.

{0};

m_eventInfoKey

Gaudi::Property<std::string> MakeEventStreamInfo::m_eventInfoKey {this, "EventInfoKey", "EventInfo", "name of the xAOD::EventInfo"}

private

Key, the StoreGate key for the xAOD::EventInfo object.

Definition at line 56 of file MakeEventStreamInfo.h.

{this, "EventInfoKey", "EventInfo", "name of the xAOD::EventInfo"};

m_eventStore

ServiceHandle<StoreGateSvc> MakeEventStreamInfo::m_eventStore {this, "StoreGateSvc", "StoreGateSvc"}

private

Definition at line 60 of file MakeEventStreamInfo.h.

{this, "StoreGateSvc", "StoreGateSvc"};

m_key

Gaudi::Property<std::string> MakeEventStreamInfo::m_key {this, "Key", "", "name of the EventStreamInfo object"}

private

Key, the StoreGate key for the EventStreamInfo object.

Definition at line 53 of file MakeEventStreamInfo.h.

{this, "Key", "", "name of the EventStreamInfo object"};

m_metaDataSvc

ServiceHandle<IAthMetaDataSvc> MakeEventStreamInfo::m_metaDataSvc {this, "MetaDataSvc", "MetaDataSvc"}

private

Pointer to the data stores.

Definition at line 59 of file MakeEventStreamInfo.h.

{this, "MetaDataSvc", "MetaDataSvc"};

---

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

• MakeEventStreamInfo.h
• MakeEventStreamInfo.cxx