PileUpStream.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef PILEUPSTREAM_PILEUPSTREAM_H
#define PILEUPSTREAM_PILEUPSTREAM_H
 
#include <string>
 
// Framework include files
#include "GaudiKernel/IEvtSelector.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthMessaging.h"
 
#include "PileUpTools/PileUpMergeSvc.h"
#include "xAODEventInfo/EventInfo.h" //typedef, cannot fwd declare
 
// Forward declarations
class ISvcLocator;
class StoreGateSvc;
 

class PileUpStream
  : public AthMessaging
{
public:
  typedef IEvtSelector::Context EvtIterator;


  PileUpStream();
  PileUpStream(const PileUpStream& rhs) = delete;
  PileUpStream& operator=(const PileUpStream& rhs) = delete;
  PileUpStream(PileUpStream&& rhs);
  PileUpStream& operator=(PileUpStream&& rhs);
  PileUpStream(const std::string& name,
           ISvcLocator* svcLoc,
           const std::string& selecName);
  PileUpStream(const std::string& name, 
           ISvcLocator* svcLoc,
           IEvtSelector* sel);
 
  virtual ~PileUpStream();

  inline const std::string& name() { return m_name; }
  inline IEvtSelector& selector() { return *m_sel; }
  inline EvtIterator& iterator() { return *p_iter; }
  inline StoreGateSvc& store() { return *m_SG; }
  inline const IEvtSelector& selector() const { return *m_sel; }
  inline const EvtIterator& iterator() const { return *p_iter; }
  inline const StoreGateSvc& store() const { return *m_SG; }

  const xAOD::EventInfo* nextEventPre(bool readRecord=true);

  bool nextEventPre_Passive(bool readRecord);

  bool setupStore();
  inline bool setupStore(bool ) { return setupStore();}

  StatusCode finalize();

  bool used() const {return m_used;}
  void setUsed() {m_used=true;}
  void resetUsed() {m_used=false;}
  bool hasRing() const { return m_hasRing; }
  unsigned int originalIRing() const { return m_iOriginalRing; }
  void setOriginalIRing(unsigned int iR) {
    if (!m_hasRing) {
      m_hasRing=true;
      m_iOriginalRing=iR; 
    }
  }
 
 
private:
  ISvcLocator* serviceLocator() { return p_svcLoc; }

  StatusCode nextRecordPre();

  StatusCode nextRecordPre_Passive();

  bool loadStore();
 
  void setActiveStore();

  std::string m_name;
  ISvcLocator* p_svcLoc{nullptr};
  SmartIF<IEvtSelector> m_sel;
  SmartIF<StoreGateSvc> m_SG;
  EvtIterator* p_iter{nullptr};
 
  ServiceHandle<PileUpMergeSvc> m_mergeSvc;
  
 
  bool m_ownEvtIterator{false}; 
  bool m_neverLoaded{true};     
  bool m_ownStore{false};       
 
  bool m_used{false};  
  bool m_hasRing{false};
  unsigned int m_iOriginalRing{0}; 
};
#endif // PILEUPSTREAM_PILEUPSTREAM_H