| 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 // G4DCofThisEvent
27 //
28 // Class description:
29 //
30 // This is a class which stores digi collections generated at one event.
31 // This class is exclusively constructed by G4DigiManager when the first
32 // digi collection of an event is passed to the manager, and this class
33 // object is deleted by G4RunManager when a G4Event class object is deleted.
34 // Almost all public methods must be used by Geant4 kernel classes and
35 // the user should not invoke them. The user can use two const methods,
36 // GetDC() and GetNumberOfCollections() for accessing to the stored digi
37 // collection(s).
38 //
39 // Author: Makoto Asai
40 // --------------------------------------------------------------------
41 #ifndef G4DCofThisEvent_h
42 #define G4DCofThisEvent_h 1
43
44 #include "G4Allocator.hh"
45 #include "G4VDigiCollection.hh"
46 #include "globals.hh"
47
48 #include <vector>
49
50 class G4DCofThisEvent
51 {
52 public:
53
54 G4DCofThisEvent();
55 explicit G4DCofThisEvent(G4int cap);
56 ~G4DCofThisEvent();
57 G4DCofThisEvent(const G4DCofThisEvent&);
58 G4DCofThisEvent& operator=(const G4DCofThisEvent&);
59
60 inline void* operator new(std::size_t);
61 inline void operator delete(void* anDCoTE);
62
63 void AddDigiCollection(G4int DCID, G4VDigiCollection* aDC);
64
65 // Returns a pointer to a digi collection.
66 // Returns `nullptr` if the particular collection is not stored in the current event.
67 // The integer argument is ID number which is assigned by G4DigiManager
68 // and the number can be obtained by G4DigiManager::GetDigiCollectionID()
69 // method.
70 inline G4VDigiCollection* GetDC(G4int i) const { return (*DC)[i]; }
71
72 // Return number of digi collections stored
73 inline G4int GetNumberOfCollections() const
74 {
75 G4int n = 0;
76 for (const G4VDigiCollection* dc : *DC) {
77 if (dc != nullptr) ++n;
78 }
79 return n;
80 }
81
82 inline std::size_t GetCapacity() const { return DC->size(); }
83
84 private:
85
86 std::vector<G4VDigiCollection*>* DC;
87 };
88
89 #if defined G4DIGI_ALLOC_EXPORT
90 extern G4DLLEXPORT G4Allocator<G4DCofThisEvent>*& anDCoTHAllocator_G4MT_TLS_();
91 #else
92 extern G4DLLIMPORT G4Allocator<G4DCofThisEvent>*& anDCoTHAllocator_G4MT_TLS_();
93 #endif
94
95 inline void* G4DCofThisEvent::operator new(std::size_t)
96 {
97 if (anDCoTHAllocator_G4MT_TLS_() == nullptr) {
98 anDCoTHAllocator_G4MT_TLS_() = new G4Allocator<G4DCofThisEvent>;
99 }
100 return (void*)anDCoTHAllocator_G4MT_TLS_()->MallocSingle();
101 }
102
103 inline void G4DCofThisEvent::operator delete(void* anDCoTH)
104 {
105 anDCoTHAllocator_G4MT_TLS_()->FreeSingle((G4DCofThisEvent*)anDCoTH);
106 }
107
108 #endif
109