Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/digits_hits/detector/include/G4VSensitiveDetector.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /digits_hits/detector/include/G4VSensitiveDetector.hh (Version 11.3.0) and /digits_hits/detector/include/G4VSensitiveDetector.hh (Version 9.6.p1)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
 26 // G4VSensitiveDetector                        << 
 27 //                                                 26 //
 28 // Class description:                          <<  27 // $Id$
 29 //                                                 28 //
 30 // This is the abstract base class of the sens <<  29 
 31 // sensitive detector which generates hits mus << 
 32 // class.                                      << 
 33 // In the derived class constructor, name(s) o << 
 34 // are made by the sensitive detector must be  << 
 35 // vector.                                     << 
 36 //                                             << 
 37 // Author: Makoto Asai                         << 
 38 // ------------------------------------------- << 
 39 #ifndef G4VSensitiveDetector_h                     30 #ifndef G4VSensitiveDetector_h
 40 #define G4VSensitiveDetector_h 1                   31 #define G4VSensitiveDetector_h 1
 41                                                    32 
 42 #include "G4CollectionNameVector.hh"           << 
 43 #include "G4HCofThisEvent.hh"                  << 
 44 #include "G4Step.hh"                           << 
 45 #include "G4TouchableHistory.hh"               << 
 46 #include "G4VHit.hh"                               33 #include "G4VHit.hh"
                                                   >>  34 #include "G4Step.hh"
                                                   >>  35 #include "G4HCofThisEvent.hh"
 47 #include "G4VReadOutGeometry.hh"                   36 #include "G4VReadOutGeometry.hh"
                                                   >>  37 #include "G4TouchableHistory.hh"
                                                   >>  38 #include "G4CollectionNameVector.hh"
 48 #include "G4VSDFilter.hh"                          39 #include "G4VSDFilter.hh"
 49                                                    40 
 50 class G4VSensitiveDetector                     <<  41 // class description:
                                                   >>  42 //
                                                   >>  43 //  This is the abstract base class of the sensitive detector. The user's
                                                   >>  44 // sensitive detector which generates hits must be derived from this
                                                   >>  45 // class.
                                                   >>  46 //  In the derived class constructor, name(s) of hits collection(s) which
                                                   >>  47 // are made by the sensitive detector must be set to "collectionName" string
                                                   >>  48 // vector.
                                                   >>  49 
                                                   >>  50 class G4VSensitiveDetector 
 51 {                                                  51 {
 52  public:                                       <<  52 
 53   // Constructors. The user's concrete class m <<  53   public: // with description
 54   // by the constructor initializer of the der <<  54       G4VSensitiveDetector(G4String name);
 55   // the sensitive detector must be unique.    <<  55       G4VSensitiveDetector(const G4VSensitiveDetector &right);
 56   explicit G4VSensitiveDetector(const G4String <<  56       // Constructors. The user's concrete class must use one of these constructors
 57   G4VSensitiveDetector(const G4VSensitiveDetec <<  57       // by the constructor initializer of the derived class. The name of
 58   G4VSensitiveDetector& operator=(const G4VSen <<  58       // the sensitive detector must be unique.
 59   virtual ~G4VSensitiveDetector() = default;   <<  59 
 60                                                <<  60   public:
 61   G4bool operator==(const G4VSensitiveDetector <<  61       virtual ~G4VSensitiveDetector();
 62   G4bool operator!=(const G4VSensitiveDetector <<  62 
 63                                                <<  63       const G4VSensitiveDetector & operator=(const G4VSensitiveDetector &right);
 64   //  These two methods are invoked at the beg <<  64 
 65   // event. The hits collection(s) created by  <<  65       G4int operator==(const G4VSensitiveDetector &right) const;
 66   // be set to the G4HCofThisEvent object at o <<  66       G4int operator!=(const G4VSensitiveDetector &right) const;
 67   virtual void Initialize(G4HCofThisEvent*) {} <<  67 
 68   virtual void EndOfEvent(G4HCofThisEvent*) {} <<  68   public: // with description
 69                                                <<  69       virtual void Initialize(G4HCofThisEvent*);
 70   //  This method is invoked if the event abor <<  70       virtual void EndOfEvent(G4HCofThisEvent*);
 71   // created but not beibg set to G4HCofThisEv <<  71       //  These two methods are invoked at the begining and at the end of each
 72   // deleted. Collection(s) which have already <<  72       // event. The hits collection(s) created by this sensitive detector must
 73   // deleted automatically.                    <<  73       // be set to the G4HCofThisEvent object at one of these two methods.
 74   virtual void clear() {}                      <<  74       virtual void clear();
 75                                                <<  75       //  This method is invoked if the event abortion is occured. Hits collections
 76   virtual void DrawAll() {}                    <<  76       // created but not beibg set to G4HCofThisEvent at the event should be deleted.
 77   virtual void PrintAll() {}                   <<  77       // Collection(s) which have already set to G4HCofThisEvent will be deleted 
 78                                                <<  78       // automatically.
 79   //  This is the public method invoked by G4S <<  79 
 80   // hit(s). The actual user's implementation  <<  80   public:
 81   // implemented in GenerateHits() virtual pro <<  81       virtual void DrawAll();
 82   // MUST NOT be overriden.                    <<  82       virtual void PrintAll();
 83   inline G4bool Hit(G4Step* aStep)             <<  83 
 84   {                                            <<  84   protected: // with description
 85     G4TouchableHistory* ROhis = nullptr;       <<  85       virtual G4bool ProcessHits(G4Step*aStep,G4TouchableHistory*ROhist) = 0;
 86     if (! isActive()) return false;            <<  86       //  The user MUST implement this method for generating hit(s) using the 
 87     if (filter != nullptr) {                   <<  87       // information of G4Step object. Note that the volume and the position
 88       if (! (filter->Accept(aStep))) return fa <<  88       // information is kept in PreStepPoint of G4Step.
 89     }                                          <<  89       //  Be aware that this method is a protected method and it sill be invoked 
 90     if (ROgeometry != nullptr) {               <<  90       // by Hit() method of Base class after Readout geometry associated to the
 91       if (! (ROgeometry->CheckROVolume(aStep,  <<  91       // sensitive detector is handled.
 92     }                                          <<  92       //  "ROhist" will be given only is a Readout geometry is defined to this
 93     return ProcessHits(aStep, ROhis);          <<  93       // sensitive detector. The G4TouchableHistory object of the tracking geometry
 94   }                                            <<  94       // is stored in the PreStepPoint object of G4Step.
 95                                                <<  95       virtual G4int GetCollectionID(G4int i);
 96   //  Register the Readout geometry.           <<  96       //  This is a utility method which returns the hits collection ID of the
 97   inline void SetROgeometry(G4VReadOutGeometry <<  97       // "i"-th collection. "i" is the order (starting with zero) of the collection
 98                                                <<  98       // whose name is stored to the collectionName protected vector.
 99   //  Register a filter                        <<  99       G4CollectionNameVector collectionName;
100   inline void SetFilter(G4VSDFilter* value) {  << 100       //  This protected name vector must be filled at the constructor of the user's
101                                                << 101       // concrete class for registering the name(s) of hits collection(s) being
102   inline G4int GetNumberOfCollections() const  << 102       // created by this particular sensitive detector.
103   inline const G4String& GetCollectionName(G4i << 103 
104   inline void SetVerboseLevel(G4int vl) { verb << 104   protected:
105   inline void Activate(G4bool activeFlag) { ac << 105       G4String SensitiveDetectorName; // detector name
106   inline G4bool isActive() const { return acti << 106       G4String thePathName;           // directory path
107   inline const G4String& GetName() const { ret << 107       G4String fullPathName;          // path + detector name
108   inline const G4String& GetPathName() const { << 108       G4int verboseLevel;
109   inline const G4String& GetFullPathName() con << 109       G4bool active;
110   inline G4VReadOutGeometry* GetROgeometry() c << 110       G4VReadOutGeometry * ROgeometry;
111   inline G4VSDFilter* GetFilter() const { retu << 111       G4VSDFilter* filter;
112                                                << 112 
113   virtual G4VSensitiveDetector* Clone() const; << 113   public: // with description
114                                                << 114       inline G4bool Hit(G4Step*aStep)
115  protected:  // with description               << 115       {
116   //  The user MUST implement this method for  << 116         G4TouchableHistory* ROhis = 0;
117   // information of G4Step object. Note that t << 117         if(!isActive()) return false;
118   // information is kept in PreStepPoint of G4 << 118         if(filter)
119   //  Be aware that this method is a protected << 119         { if(!(filter->Accept(aStep))) return false; }
120   // by Hit() method of Base class after Reado << 120         if(ROgeometry)
121   // sensitive detector is handled.            << 121         { if(!(ROgeometry->CheckROVolume(aStep,ROhis))) return false; }
122   //  "ROhist" will be given only is a Readout << 122         return ProcessHits(aStep,ROhis);
123   // sensitive detector. The G4TouchableHistor << 123       }
124   // is stored in the PreStepPoint object of G << 124       //  This is the public method invoked by G4SteppingManager for generating
125   virtual G4bool ProcessHits(G4Step* aStep, G4 << 125       // hit(s). The actual user's implementation for generating hit(s) must be
126                                                << 126       // implemented in GenerateHits() virtual protected method. This method
127   //  This is a utility method which returns t << 127       // MUST NOT be overrided.
128   // "i"-th collection. "i" is the order (star << 128       inline void SetROgeometry(G4VReadOutGeometry*value)
129   // whose name is stored to the collectionNam << 129       { ROgeometry = value; }
130   virtual G4int GetCollectionID(G4int i);      << 130       //  Register the Readout geometry.
131                                                << 131       inline void SetFilter(G4VSDFilter*value)
132  protected:                                    << 132       { filter = value; }
133   //  This protected name vector must be fille << 133       //  Register a filter
134   // concrete class for registering the name(s << 134 
135   // created by this particular sensitive dete << 135   public:
136   G4CollectionNameVector collectionName;       << 136       inline G4int GetNumberOfCollections() const
137                                                << 137       { return collectionName.size(); }
138   G4String SensitiveDetectorName;  // detector << 138       inline G4String GetCollectionName(G4int id) const
139   G4String thePathName;  // directory path     << 139       { return collectionName[id]; }
140   G4String fullPathName;  // path + detector n << 140       inline void SetVerboseLevel(G4int vl)
141   G4int verboseLevel{0};                       << 141       { verboseLevel = vl; }
142   G4bool active{true};                         << 142       inline void Activate(G4bool activeFlag)
143   G4VReadOutGeometry* ROgeometry{nullptr};     << 143       { active = activeFlag; }
144   G4VSDFilter* filter{nullptr};                << 144       inline G4bool isActive() const
                                                   >> 145       { return active; }
                                                   >> 146       inline G4String GetName() const
                                                   >> 147       { return SensitiveDetectorName; }
                                                   >> 148       inline G4String GetPathName() const
                                                   >> 149       { return thePathName; }
                                                   >> 150       inline G4String GetFullPathName() const
                                                   >> 151       { return fullPathName; }
                                                   >> 152       inline G4VReadOutGeometry* GetROgeometry() const
                                                   >> 153       { return ROgeometry; }
                                                   >> 154       inline G4VSDFilter* GetFilter() const
                                                   >> 155       { return filter; }
145 };                                                156 };
146                                                   157 
                                                   >> 158 
                                                   >> 159 
                                                   >> 160 
147 #endif                                            161 #endif
                                                   >> 162 
148                                                   163