| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4VPrimitiveScorer
27 //
28 // Class description:
29 //
30 // This is the base class of the sensitive detector which owns
31 // only one hits collection.
32 // A concrete class object derived from this base class can be
33 // used either as a sensitive detector or to be registered to
34 // G4MultiFunctionalDetector to define multiple functionalities.
35 //
36 // Author: Makoto Asai
37 // --------------------------------------------------------------------
38 #ifndef G4VPrimitiveScorer_h
39 #define G4VPrimitiveScorer_h 1
40
41 #include "G4MultiFunctionalDetector.hh"
42 #include "G4VSDFilter.hh"
43 #include "globals.hh"
44
45 class G4Step;
46 class G4HCofThisEvent;
47 class G4TouchableHistory;
48
49 class G4VPrimitiveScorer
50 {
51 friend class G4MultiFunctionalDetector;
52
53 public:
54 G4VPrimitiveScorer(const G4String& name, G4int depth = 0);
55 virtual ~G4VPrimitiveScorer() = default;
56
57 // This method returns the ID of its hitsCollection. This mehod
58 // gives valid value only after it is registered to G4MultiFunctionalDetector
59 // and the G4MultiFunctionalDetector is registered to G4SDManager.
60 G4int GetCollectionID(G4int);
61
62 // These five methods are exactly identical to those in G4VSensitiveDetector.
63 // These methods are invoked by G4SDManager through G4MultiFunctionalDetector.
64 virtual void Initialize(G4HCofThisEvent*);
65 virtual void EndOfEvent(G4HCofThisEvent*);
66 virtual void clear();
67 virtual void DrawAll();
68 virtual void PrintAll();
69
70 void SetUnit(const G4String& unit) { unitName = unit; }
71 const G4String& GetUnit() const { return unitName; }
72 G4double GetUnitValue() const { return unitValue; }
73
74 // Set/Get methods
75 inline void SetMultiFunctionalDetector(G4MultiFunctionalDetector* d) { detector = d; }
76 inline G4MultiFunctionalDetector* GetMultiFunctionalDetector() const { return detector; }
77 inline const G4String& GetName() const { return primitiveName; }
78 inline void SetFilter(G4VSDFilter* f) { filter = f; }
79 inline G4VSDFilter* GetFilter() const { return filter; }
80 inline void SetVerboseLevel(G4int vl) { verboseLevel = vl; }
81 inline G4int GetVerboseLevel() const { return verboseLevel; }
82
83 inline void SetNijk(G4int i, G4int j, G4int k)
84 {
85 fNi = i;
86 fNj = j;
87 fNk = k;
88 }
89
90 protected:
91 // Get the solid at current depth, ensuring it's correct by
92 // calling a parameterisation is called if it's that volume type
93 G4VSolid* ComputeSolid(G4Step* aStep, G4int replicaIdx);
94
95 // Same as above -- using stored replica number
96 G4VSolid* ComputeCurrentSolid(G4Step* aStep);
97
98 // This is the method must be implemented in each concrete class.
99 virtual G4bool ProcessHits(G4Step*, G4TouchableHistory*) = 0;
100
101 // This is a function mapping from copy number(s) to an index of
102 // the hit collection. In the default implementation, just the
103 // copy number of the physical volume is taken.
104 virtual G4int GetIndex(G4Step*);
105
106 void CheckAndSetUnit(const G4String& unit, const G4String& category);
107
108 protected:
109 G4String primitiveName;
110 G4MultiFunctionalDetector* detector{nullptr};
111 G4VSDFilter* filter{nullptr};
112 G4int verboseLevel{0};
113 G4int indexDepth;
114 G4String unitName{"NoUnit"};
115 G4double unitValue{1.0};
116 G4int fNi{0}, fNj{0}, fNk{0}; // used for 3D scorers
117
118 private:
119 inline G4bool HitPrimitive(G4Step* aStep, G4TouchableHistory* ROhis)
120 {
121 if (filter != nullptr) {
122 if (! (filter->Accept(aStep))) return false;
123 }
124 return ProcessHits(aStep, ROhis);
125 }
126 };
127
128 #endif
129