AthAnalysisAlgorithm.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
// AthAnalysisAlgorithm.h 
// Header file for class AthAnalysisAlgorithm
// Inherits from AthHistogramAlgorithm
// Author: W.Buttinger<will@cern.ch>
 
#ifndef ATHANALYSISBASECOMPS_ATHANALYSISALGORITHM_H
#define ATHANALYSISBASECOMPS_ATHANALYSISALGORITHM_H 1
 
 
#include "AthenaBaseComps/AthHistogramAlgorithm.h"
#include "GaudiKernel/ToolHandle.h" //included under assumption you'll want to use some tools!
#include "GaudiKernel/IIncidentSvc.h"
 
 
#include "AthAnalysisBaseComps/AthAnalysisHelper.h"
#include "TFile.h"
 
class AthAnalysisAlgorithm : public ::AthHistogramAlgorithm, virtual public IIncidentListener {
 public:

  AthAnalysisAlgorithm(const std::string& name);

  AthAnalysisAlgorithm(const std::string& name, ISvcLocator* pSvcLocator);
 
  virtual ~AthAnalysisAlgorithm() override;


  const ServiceHandle< StoreGateSvc >& inputMetaStore() const { return m_inputMetaStore; }
  ServiceHandle< StoreGateSvc >& inputMetaStore() { return m_inputMetaStore; }
  const ServiceHandle< StoreGateSvc >& outputMetaStore() const { return m_outputMetaStore; }
  ServiceHandle< StoreGateSvc >& outputMetaStore() { return m_outputMetaStore; }


  virtual StatusCode sysInitialize() override;
  virtual StatusCode sysExecute(const EventContext&) override;

    template<typename T> StatusCode retrieveMetadata(const std::string& folder, const std::string& key, T& out) {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore());
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

    template<typename T> StatusCode retrieveMetadata(const std::string& folder, const std::string& key, T& out, const IOVTime& time, int channel=-1) {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore(),time,channel);
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }
 
protected:
  void updateEvtStore(Gaudi::Details::PropertyBase& prop);
 

    virtual void handle( const Incident& inc ) override;

    virtual StatusCode beginInputFile();

    virtual StatusCode endInputFile();

    virtual StatusCode metaDataStop();

    virtual StatusCode firstExecute();

    virtual TFile* currentFile(const char* evtSelName="EventSelector") final;
 
private:
  ServiceHandle< StoreGateSvc > m_inputMetaStore;
  ServiceHandle< StoreGateSvc > m_outputMetaStore;
 
  TFile* m_currentFile{nullptr}; //used to cache the current file
 
  bool m_doneFirstEvent{false};
};
 
#endif //> !ATHANALYSISBASECOMPS_ATHANALYSISALGORITHM_H