| 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 // G4SDManager
27 //
28 // Class description:
29 //
30 // This is a singleton class which manages the sensitive detectors.
31 // The user cannot access to the constructor. The pointer of the
32 // only existing object can be got via G4SDManager::GetSDMpointer()
33 // static method. The first invokation of this static method makes
34 // the singleton object.
35 //
36 // Author: Makoto Asai
37 // --------------------------------------------------------------------
38 #ifndef G4SDManager_h
39 #define G4SDManager_h 1
40
41 #include "G4HCtable.hh"
42 #include "G4SDStructure.hh"
43 #include "globals.hh"
44 #include "G4VSDFilter.hh"
45
46 #include <vector>
47
48 class G4VHitsCollection;
49 class G4VSensitiveDetector;
50 class G4HCofThisEvent;
51 class G4SDmessenger;
52
53 class G4SDManager
54 {
55 public:
56 // Returns the pointer to the singleton object, creating it if not null
57 static G4SDManager* GetSDMpointer();
58
59 // Returns current pointer to the singleton object
60 // Caller is responsible for checking value against `nullptr`
61 static G4SDManager* GetSDMpointerIfExist();
62
63 G4SDManager(const G4SDManager&) = delete;
64 G4SDManager& operator=(const G4SDManager&) = delete;
65 ~G4SDManager();
66
67 // Register sensitive detector instance
68 // This method must be invoked when the user constructs their sensitive detector
69 void AddNewDetector(G4VSensitiveDetector* aSD);
70
71 // Activate/inactivate the registered sensitive detector.
72 // For the inactivated detectors, hits collections will not be stored to the G4HCofThisEvent
73 // object.
74 void Activate(const G4String& dName, G4bool activeFlag);
75
76 // Return ID number of sensitive detector with given name
77 G4int GetCollectionID(const G4String& colName);
78
79 // Return ID number of sensitive detector creating given hits collection
80 G4int GetCollectionID(G4VHitsCollection* aHC);
81
82 G4VSensitiveDetector* FindSensitiveDetector(const G4String& dName, G4bool warning = true);
83 G4HCofThisEvent* PrepareNewEvent();
84 void TerminateCurrentEvent(G4HCofThisEvent* HCE);
85 void AddNewCollection(const G4String& SDname, const G4String& DCname);
86
87 inline void SetVerboseLevel(G4int vl)
88 {
89 verboseLevel = vl;
90 treeTop->SetVerboseLevel(vl);
91 }
92 inline G4SDStructure* GetTreeTop() const { return treeTop; }
93 inline void ListTree() const { treeTop->ListTree(); }
94 inline G4int GetCollectionCapacity() const { return HCtable->entries(); }
95 inline G4HCtable* GetHCtable() const { return HCtable; }
96
97 void RegisterSDFilter(G4VSDFilter* filter);
98 void DeRegisterSDFilter(G4VSDFilter* filter);
99
100 protected:
101 G4SDManager();
102
103 private:
104 void DestroyFilters();
105
106 private:
107 static G4ThreadLocal G4SDManager* fSDManager;
108 G4SDStructure* treeTop;
109 G4int verboseLevel{0};
110 G4HCtable* HCtable;
111 G4SDmessenger* theMessenger;
112 std::vector<G4VSDFilter*> FilterList;
113 };
114
115 #endif
116