OutputStreamSequencerSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef OUTPUTSTREAMSEQUENCERSVC_H
#define OUTPUTSTREAMSEQUENCERSVC_H

 
#include "GaudiKernel/ServiceHandle.h"
#include "Gaudi/Property.h"  // no forward decl: typedef
#include "GaudiKernel/IIncidentListener.h"
#include "AthenaBaseComps/AthService.h"
#include "AthenaKernel/SlotSpecificObj.h"
 
#include <memory>
#include <map>
#include <mutex>
 
// Forward declarations
class MetaDataSvc;
 

class OutputStreamSequencerSvc : public extends<AthService,
                                                IIncidentListener> {
 
 public:
  using IService::interfaceID;
  typedef std::pair<std::string,std::string> RangeReport_t; // (RangeID,RangeFileName)
  typedef std::unique_ptr<RangeReport_t>     RangeReport_ptr;
 
public: // Constructor and Destructor

   OutputStreamSequencerSvc(const std::string& name, ISvcLocator* pSvcLocator);
   virtual ~OutputStreamSequencerSvc();
 
public: // Non-static members
   virtual StatusCode initialize() override final;
   virtual StatusCode finalize() override final;

   virtual void handle(const Incident& /*inc*/) override final;

   std::string buildSequenceFileName(const EventContext& ctx, const std::string&);
   void publishRangeReport(const std::string& outputFile);
   RangeReport_ptr getRangeReport();

   std::string  incidentName() const            { return m_incidentName.value(); }

   std::string  currentRangeID(const EventContext& ctx) const;

   std::string  setRangeID(const EventContext& ctx, const std::string & rangeID);

   bool         inUse() const;
  
   static bool  inConcurrentEventsMode();

   const std::string& lastIncident()            { return m_lastIncident; }
 
private: // data
   ServiceHandle<MetaDataSvc> m_metaDataSvc;

   int m_fileSequenceNumber{};

   std::string  m_currentRangeID;

   std::string  m_lastFileName;

   std::string  m_lastIncident;

   SG::SlotSpecificObj<std::string, SG::InvalidSlot::Enabled> m_rangeIDinSlot;
 
private: // properties
   StringProperty             m_incidentName {this, "SequenceIncidentName", "",
         "Name of the incident that signals the next Event Range start" };

   BooleanProperty            m_reportingOn {this, "ReportingOn", false,
         "If True, keep info about Ranges for getRangeReport() calls"};

   BooleanProperty m_replaceRangeMode{
       this, "ReplaceRangeMode", false,
       "If True, everything between [ and ] in the output filename is treated "
       "as a comma-separated list, and the range_idth element of the list is "
       "selected"};
 
   std::map<std::string,std::string> m_fnToRangeId;
   std::map<std::string,std::string>::iterator m_finishedRange{};
 
   mutable std::mutex         m_mutex;
};
 
#endif