SensitiveDetectorBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef G4ATLASTOOLS_SENSITIVEDETECTORBASE_H
#define G4ATLASTOOLS_SENSITIVEDETECTORBASE_H
 
#pragma GCC diagnostic push
// SDtools that have not yet been migrated to the new SD interface will trigger
// this warning because SetupEvent(AtlasG4EventUserInfo&) and
// Gather(AtlasG4EventUserInfo&) are hidden. this is fine, as these methods are
// not used in the old-style SDs, but should be migrated. Remove this when all
// SDs are migrated.
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
 
// Base classes
#include "AthenaBaseComps/AthAlgTool.h"
#include "G4AtlasInterfaces/ISensitiveDetector.h"
 
// Members
#include "G4VSensitiveDetector.hh"
#include "G4Types.hh"
#ifdef G4MULTITHREADED
#  include "tbb/concurrent_unordered_map.h"
#endif
 
// STL library
#include <string>
#include <vector>
#include <thread>
 
// Forward declarations
class G4LogicalVolume;
class G4VSensitiveDetector;
 

class SensitiveDetectorBase : public extends<AthAlgTool, ISensitiveDetector>
{
 
 public:

  SensitiveDetectorBase(const std::string& type, const std::string& name,
                        const IInterface *parent);
  virtual ~SensitiveDetectorBase() {}

  StatusCode initializeSD() override;


  virtual StatusCode SetupEvent() override { return StatusCode::SUCCESS; }
  virtual StatusCode SetupEvent(HitCollectionMap&) override {
    return SetupEvent();
  }


  virtual StatusCode Gather() override { return StatusCode::SUCCESS; }
  virtual StatusCode Gather(HitCollectionMap&) override {
    return Gather();
  };
 
 protected:


  StatusCode assignSD(std::unique_ptr<G4VSensitiveDetector> sd,
                      const std::vector<std::string>& volumes) const;
  

  G4VSensitiveDetector* getSD();

  Gaudi::Property<std::vector<std::string> > m_volumeNames{this, "LogicalVolumeNames", {}};
  Gaudi::Property<std::vector<std::string> > m_outputCollectionNames{this, "OutputCollectionNames", {}};

  Gaudi::Property<bool> m_noVolumes{this, "NoVolumes", false};

  void SetSensitiveDetector(G4LogicalVolume*, G4VSensitiveDetector*) const;
 
 private:


  void setSD(G4VSensitiveDetector*);
  

  static bool matchStrings(const char *first, const char * second);
 
#ifdef G4MULTITHREADED
  using SDThreadMap_t = tbb::concurrent_unordered_map
    < std::thread::id, G4VSensitiveDetector*, std::hash<std::thread::id> >;
  SDThreadMap_t m_sdThreadMap;
#else
  G4VSensitiveDetector* m_SD{};
#endif
 
}; // class SensitiveDetectorBase
 
#pragma GCC diagnostic pop
 
#endif