PileUpXingFolder.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef PILEUPTOOLS_PILEUPXINGFOLDER_H
#define PILEUPTOOLS_PILEUPXINGFOLDER_H 1
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
#include "PileUpTools/IPileUpXingFolder.h"

class PileUpXingFolder : public extends<AthAlgTool, IPileUpXingFolder> {
public:

  PileUpXingFolder(const std::string& type, 
           const std::string& name,
           const IInterface* parent);
  virtual StatusCode initialize();
  
  typedef IPileUpXingFolder::const_iterator const_iterator;

  virtual const_iterator begin() const { return m_folder->begin(); }
  virtual const_iterator end() const { return m_folder->end(); }
//   ///add a data object identifier to the list
//   virtual StatusCode add(const std::string& typeName, const std::string& skey) {
//     return m_folder->add(typeName, skey);
//   }
//   ///add a data object identifier to the list
//   virtual StatusCode add(const CLID& clid, const std::string& skey) {
//     return m_folder->add(clid, skey);
//   }
  

  void setXings(int firstXing, int lastXing) {
    m_firstXing.setValue(firstXing); m_lastXing.setValue(lastXing);
  } 
  int firstXing() const { return m_firstXing.value(); }
  int lastXing() const  { return m_lastXing.value(); }

  float cacheRefreshFrequency() const {return m_cacheRefreshFrequency.value();}
 

  bool contains(int iCrossing) const {
    return firstXing() <= iCrossing && iCrossing <= lastXing();
  }
 
private:
  ToolHandle<SG::IFolder> m_folder;
 
  Gaudi::Property<int> m_firstXing{this, "FirstXing", -999,
    "First bunch crossing"};
  Gaudi::Property<int> m_lastXing{this, "LastXing", 999,
    "Last bunch crossing"};
  Gaudi::Property<std::vector<std::string>> m_itemList{this, "ItemList", {},
    "List of data object identifiers"};
  Gaudi::CheckedProperty<double> m_cacheRefreshFrequency{this, "CacheRefreshFrequency", 0.0,
    "Frequency with which data objs in this folder should be cleared from bkg caches "
    "at end of event. Default 0 (never clear), range [0.0, 1.0]"};
};
 
#endif