PHG4Subsystem.h

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

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

#include <fun4all/Fun4AllReturnCodes.h>
#include <fun4all/SubsysReco.h>

#include <iostream>
#include <string>

class G4LogicalVolume;
class G4ParticleDefinition;
class PHCompositeNode;
class PHG4Detector;
class PHG4DisplayAction;
class PHG4EventAction;
class PHG4StackingAction;
class PHG4SteppingAction;
class PHG4TrackingAction;

class PHG4Subsystem : public SubsysReco
{
 public:
  PHG4Subsystem(const std::string &name = "Generic Subsystem")
    : SubsysReco(name)
  {
  }

  ~PHG4Subsystem(void) override {}

  virtual int process_after_geant(PHCompositeNode *)
  {
    return Fun4AllReturnCodes::EVENT_OK;
  }

  virtual PHG4Detector *GetDetector(void) const
  {
    return nullptr;
  }

  virtual PHG4EventAction *GetEventAction(void) const
  {
    return nullptr;
  }

  virtual PHG4SteppingAction *GetSteppingAction(void) const
  {
    return nullptr;
  }

  virtual PHG4TrackingAction *GetTrackingAction(void) const
  {
    return nullptr;
  }

  virtual PHG4DisplayAction *GetDisplayAction() const
  {
    return nullptr;
  }

  virtual PHG4StackingAction *GetStackingAction() const {return nullptr;}

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

  bool CheckOverlap() const { return overlapcheck; }

  void SetMotherSubsystem(PHG4Subsystem *subsys);
  PHG4Subsystem *GetMotherSubsystem() const { return m_MyMotherSubsystem; }

  void SetLogicalVolume(G4LogicalVolume *vol) { m_MyLogicalVolume = vol; }
  G4LogicalVolume *GetLogicalVolume() const { return m_MyLogicalVolume; }

// this method is used to check if it can be used as mothervolume
// Subsystems which can be mothervolume need to implement this 
// and return true
  virtual bool CanBeMotherSubsystem() const {return false;}

//
  virtual void AddProcesses(G4ParticleDefinition */*particle*/) {}

// define materials used in detector
  virtual void DefineMaterials() {}

 private:
  PHG4Subsystem *m_MyMotherSubsystem = nullptr;
  G4LogicalVolume *m_MyLogicalVolume = nullptr;
  bool overlapcheck = false;
};

#endif  // G4MAIN_PHG4SUBSYSTEM_H