GGSDataProvider.h

Go to the documentation of this file.

/*
 * GGSDataProvider.h
 *
 *  Created on: 14 Nov 2018
 *      Author: Nicola Mori
 */
 
#ifndef HERD_GGSDATAPROVIDER_H_
#define HERD_GGSDATAPROVIDER_H_
 
// HerdSoftware headers
#include "herd/analysis/dataobjects/CaloGeoParams.h"
#include "herd/analysis/dataobjects/CaloHits.h"
#include "herd/analysis/dataobjects/CaloLpdHits.h"
#include "herd/analysis/dataobjects/CaloSpdHits.h"
#include "herd/analysis/dataobjects/CssGeoParams.h"
#include "herd/analysis/dataobjects/FitGeoParamsColl.h"
#include "herd/analysis/dataobjects/FitHitsColl.h"
#include "herd/analysis/dataobjects/FitParticleHitsColl.h"
#include "herd/analysis/dataobjects/MCGenerationInfo.h"
#include "herd/analysis/dataobjects/MCTruth.h"
#include "herd/analysis/dataobjects/PsdGeoParamsColl.h"
#include "herd/analysis/dataobjects/PsdHitsColl.h"
#include "herd/analysis/dataobjects/PsdParticleHitsColl.h"
#include "herd/analysis/dataobjects/ScdGeoParamsColl.h"
#include "herd/analysis/dataobjects/ScdHitsColl.h"
#include "herd/analysis/dataobjects/ScdParticleHitsColl.h"
 
// HS readers
#include "herd/analysis/dataproviders/readers/event/GGSCaloHitsReader.h"
#include "herd/analysis/dataproviders/readers/event/GGSCaloLpdHitsReader.h"
#include "herd/analysis/dataproviders/readers/event/GGSCaloSpdHitsReader.h"
#include "herd/analysis/dataproviders/readers/event/GGSFitHitsReader.h"
#include "herd/analysis/dataproviders/readers/event/GGSMCTruthReader.h"
#include "herd/analysis/dataproviders/readers/event/GGSPsdHitsReader.h"
#include "herd/analysis/dataproviders/readers/event/GGSScdHitsReader.h"
#include "herd/analysis/dataproviders/readers/global/GGSMCGenReader.h"
#include "herd/analysis/dataproviders/readers/global/GGSTGeoReader.h"
#include "herd/analysis/dataproviders/readers/global/ParametricGeoCaloReader.h"
#include "herd/analysis/dataproviders/readers/global/ParametricGeoCssReader.h"
#include "herd/analysis/dataproviders/readers/global/ParametricGeoFitReader.h"
#include "herd/analysis/dataproviders/readers/global/ParametricGeoPsdReader.h"
#include "herd/analysis/dataproviders/readers/global/ParametricGeoScdReader.h"
 
#ifndef GGSSMARTLOG_H_
#define HERD_GGSDATAPROVIDER_H_UNDEF_LOGGING
#endif
 
// GGS headers
#include "montecarlo/dataobjs/GGSTHits.h"
#include "montecarlo/readers/GGSTRootReader.h"
 
class GGSTHitsReader;
class GGSTMCTruthReader;
class GGSTHadrIntReader;
class GGSTPrimaryDisReader;
 
#ifdef HERD_GGSDATAPROVIDER_H_UNDEF_LOGGING
// Remove the definitions of GGS output macros (would conflict with the same macros defined in EventAnalysis)
// We only do this if GGSSmartLog.h is being parsed in this TU, otherwise there would be nothing to undef
// (or we could even be undefining the EA macros)
#undef COUT
#undef CCOUT
#undef ENDL
#endif
 
// EventAnalysis headers
#include "data/DataProvider.h"
 
// ROOT headers
#include "TGeoManager.h"
 
// Standard C++ hedaders
#include <functional>
#include <vector>
 
namespace Herd {
// clang-format off
// clang-format on
 
class GGSDataProvider : public EA::DataProvider {
public:
  GGSDataProvider(const std::string &name, const std::string &source);
 
  bool Connect() override;
 
  // avoid other overloads from base class to be hidden by derived version
  using DataProvider::SetCurrentEvent;
 
  bool SetCurrentEvent(unsigned int event) override;
 
  // avoid other overloads from base class to be hidden by derived version
  using DataProvider::GetObject;
 
  EA::RetrievalResult GetObject(const std::string &name, EA::ObjectCategory category, EA::ObjectWrapper &wrapper,
                                std::string &actualName) override;
 
  std::vector<std::string> FreeObjects(const std::vector<std::string> &objs, EA::Memory::Status memStatus) override;
 
private:
  unsigned int m_currEv;
  unsigned int m_currReadEv;
  // Utility class that wraps a std::function<bool()> and adds automatic caching,
  // for actually calling a function only once.
  class CachedFunction {
  public:
    CachedFunction() {}
    template <typename T> CachedFunction(T func) : function{func} {}
    template <typename T> CachedFunction &operator=(T func) {
      function = func;
      return *this;
    }
    bool operator()() {
      if (called) {
        return result;
      }
      called = true;
      return (result = function());
    }
 
  private:
    std::function<bool()> function;
    bool called = false;
    bool result = true;
  };
  // generic struct to describe an object
  struct ObjDescriptor {
    std::string name;
    std::vector<std::string> aliases;
    EA::ObjectCategory category;
    // these closures should capture "this" so they can see everything in the dataprovider
    CachedFunction is_available;
    std::function<EA::RetrievalResult(EA::ObjectWrapper &)> get;
    std::function<void()> post_load;
    // a list of objects this object depends on
    std::vector<ObjDescriptor> prerequisites;
  };
 
  std::vector<ObjDescriptor> m_objDescriptors = {};
 
  bool LoadPrerequisites(ObjDescriptor &objDesc);
 
  // GGS
  std::shared_ptr<GGSTRootReader> m_reader;
 
  // HS readers
  std::unique_ptr<Readers::GGSMCGenReader> m_mcGenReader = nullptr;
  std::unique_ptr<Readers::GGSTGeoReader> m_mcTGeoReader = nullptr;
  std::unique_ptr<Readers::ParametricGeoCssReader> m_mcPGCssReader = nullptr;
  std::unique_ptr<Readers::ParametricGeoCaloReader> m_mcPGCaloReader = nullptr;
  std::unique_ptr<Readers::ParametricGeoFitReader> m_mcPGFitReader = nullptr;
  std::unique_ptr<Readers::ParametricGeoPsdReader> m_mcPGPsdReader = nullptr;
  std::unique_ptr<Readers::ParametricGeoScdReader> m_mcPGScdReader = nullptr;
 
  std::unique_ptr<Readers::GGSMCTruthReader> m_mcTruthReader = nullptr;
  std::unique_ptr<Readers::GGSCaloHitsReader> m_caloHitsReader = nullptr;
  std::unique_ptr<Readers::GGSCaloLpdHitsReader> m_caloLpdHitsReader = nullptr;
  std::unique_ptr<Readers::GGSCaloSpdHitsReader> m_caloSpdHitsReader = nullptr;
  std::unique_ptr<Readers::GGSScdHitsReader> m_scdHitsReader = nullptr;
  std::unique_ptr<Readers::GGSFitHitsReader> m_fitHitsReader = nullptr;
  std::unique_ptr<Readers::GGSPsdHitsReader> m_psdHitsReader = nullptr;
};
 
} // namespace Herd
 
#endif /* HERD_GGSDATAPROVIDER_H_ */