PHG4DetectorSubsystem.h

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file PHG4DetectorSubsystem.h

// Tell emacs that this is a C++ source
//  -*- C++ -*-.
#ifndef G4DETECTORS_PHG4DETECTORSUBSYSTEM_H
#define G4DETECTORS_PHG4DETECTORSUBSYSTEM_H

#include <g4main/PHG4Subsystem.h>

#include <map>
#include <string>

class PHCompositeNode;
class PHParameters;
class PHParametersContainer;

class PHG4DetectorSubsystem : public PHG4Subsystem
{
 public:
  enum FILE_TYPE
  {
    none = 0,
    xml = 1,
    root = 2
  };

  ~PHG4DetectorSubsystem() override {}

  int Init(PHCompositeNode *) final;
  int InitRun(PHCompositeNode *) final;

  virtual int InitRunSubsystem(PHCompositeNode *) { return 0; }
  virtual int InitSubsystem(PHCompositeNode *) { return 0; }

  void OverlapCheck(const bool chk = true) { overlapcheck = chk; }
  bool CheckOverlap() const { return overlapcheck; }

  PHParameters *GetParams() const { return params; }

  // Get/Set parameters from macro
  void set_double_param(const std::string &name, const double dval);
  double get_double_param(const std::string &name) const;
  void set_int_param(const std::string &name, const int ival);
  int get_int_param(const std::string &name) const;
  void set_string_param(const std::string &name, const std::string &sval);
  std::string get_string_param(const std::string &name) const;

  void UseDB(const int i = 1) { usedb = i; }
  int ReadDB() const { return usedb; }
  FILE_TYPE get_filetype() const { return filetype; }

  void UseCalibFiles(const FILE_TYPE ftyp) { filetype = ftyp; }
  int SaveParamsToDB();
  int ReadParamsFromDB(const std::string &name, const int issuper);
  int SaveParamsToFile(const FILE_TYPE ftyp);
  int ReadParamsFromFile(const std::string &name, const FILE_TYPE ftyp, const int issuper);
  void SetCalibrationFileDir(const std::string &calibdir) { calibfiledir = calibdir; }

  void UpdateParametersWithMacro();

  void SetActive(const int i = 1);
  void SetAbsorberActive(const int i = 1);
  void SetAbsorberTruth(const int i = 1);
  void BlackHole(const int i = 1);
  void SetSupportActive(const int i = 1);

  void SuperDetector(const std::string &name);
  const std::string SuperDetector() const { return superdetector; }

  int GetLayer() const { return layer; }
  virtual void SetDefaultParameters() = 0;  // this one has to be implemented by the daughter
 protected:                                 // those cannot be executed on the cmd line
  PHG4DetectorSubsystem(const std::string &name = "GenericSubsystem", const int lyr = 0);
  // these initialize the defaults and add new entries to the
  // list of variables. This should not be possible from the macro to
  // prevent abuse (this makes the list of possible parameters deterministic)
  void InitializeParameters();
  void set_default_double_param(const std::string &name, const double dval);
  void set_default_int_param(const std::string &name, const int ival);
  void set_default_string_param(const std::string &name, const std::string &sval);
  int BeginRunExecuted() const { return beginrunexecuted; }

 private:
  PHParameters *params = nullptr;
  PHParametersContainer *paramscontainer = nullptr;
  PHCompositeNode *savetopNode = nullptr;
  bool overlapcheck = false;
  int layer = -1;
  int usedb = 0;
  int beginrunexecuted = 0;
  FILE_TYPE filetype = PHG4DetectorSubsystem::none;
  std::string superdetector = "NONE";
  std::string calibfiledir = "./";

  std::map<const std::string, double> dparams;
  std::map<const std::string, int> iparams;
  std::map<const std::string, std::string> cparams;

  std::map<const std::string, double> default_double;
  std::map<const std::string, int> default_int;
  std::map<const std::string, std::string> default_string;
};

#endif