| Geant4 Cross Reference |
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 26
27 // Class template for ntuple managers for all 27 // Class template for ntuple managers for all output types.
28 // 28 //
29 // Author: Ivana Hrivnacova, 19/06/2015 (ivan 29 // Author: Ivana Hrivnacova, 19/06/2015 (ivana@ipno.in2p3.fr)
30 30
31 #ifndef G4TNtupleManager_h 31 #ifndef G4TNtupleManager_h
32 #define G4TNtupleManager_h 1 32 #define G4TNtupleManager_h 1
33 33
34 #include "G4BaseNtupleManager.hh" 34 #include "G4BaseNtupleManager.hh"
35 #include "G4TNtupleDescription.hh" 35 #include "G4TNtupleDescription.hh"
36 #include "globals.hh" 36 #include "globals.hh"
37 37
38 #include <vector> 38 #include <vector>
39 #include <string_view> <<
40 39
41 // NT - ntuple type, FT - file type << 40 template <typename TNTUPLE>
42 template <typename NT, typename FT> <<
43 class G4TNtupleManager : public G4BaseNtupleMa 41 class G4TNtupleManager : public G4BaseNtupleManager {
44 42
45 public: 43 public:
46 explicit G4TNtupleManager(const G4Analysis 44 explicit G4TNtupleManager(const G4AnalysisManagerState& state);
47 G4TNtupleManager() = delete; << 45 ~G4TNtupleManager();
48 ~G4TNtupleManager() override; <<
49 46
50 protected: 47 protected:
51 // Methods to manipulate ntuples << 48 // Methods to manipulate ntuples
52 G4int CreateNtuple(G4NtupleBooking* ntuple << 49 virtual void CreateNtuplesFromBooking();
53 << 50 G4bool IsEmpty() const;
54 virtual void CreateNtuplesFromBooking( << 51 virtual G4bool Reset(G4bool deleteNtuple);
55 const std::vector<G4NtupleB <<
56 <<
57 virtual G4bool Reset(); <<
58 void Clear() override; <<
59 <<
60 // Method to delete selected ntuple <<
61 G4bool Delete(G4int id) override; <<
62 52
63 // Methods to create ntuples 53 // Methods to create ntuples
64 // are implemented in G4NtupleBookingManag << 54 //
>> 55 virtual G4int CreateNtuple(const G4String& name, const G4String& title) override;
>> 56
>> 57 // Create columns in the last created ntuple (from base class)
>> 58 using G4BaseNtupleManager::CreateNtupleIColumn;
>> 59 using G4BaseNtupleManager::CreateNtupleFColumn;
>> 60 using G4BaseNtupleManager::CreateNtupleDColumn;
>> 61 using G4BaseNtupleManager::CreateNtupleSColumn;
>> 62 using G4BaseNtupleManager::FinishNtuple;
>> 63 // Create columns in the ntuple with given id
>> 64 virtual G4int CreateNtupleIColumn(G4int ntupleId,
>> 65 const G4String& name, std::vector<int>* vector) final;
>> 66 virtual G4int CreateNtupleFColumn(G4int ntupleId,
>> 67 const G4String& name, std::vector<float>* vector) final;
>> 68 virtual G4int CreateNtupleDColumn(G4int ntupleId,
>> 69 const G4String& name, std::vector<double>* vector) final;
>> 70 virtual G4int CreateNtupleSColumn(G4int ntupleId, const G4String& name) final;
>> 71 virtual void FinishNtuple(G4int ntupleId) final;
65 72
66 // Methods to fill ntuples 73 // Methods to fill ntuples
67 // Methods for ntuple with id = FirstNtupl << 74 // Methods for ntuple with id = FirstNtupleId (from base class)
68 using G4BaseNtupleManager::FillNtupleIColu 75 using G4BaseNtupleManager::FillNtupleIColumn;
69 using G4BaseNtupleManager::FillNtupleFColu 76 using G4BaseNtupleManager::FillNtupleFColumn;
70 using G4BaseNtupleManager::FillNtupleDColu 77 using G4BaseNtupleManager::FillNtupleDColumn;
71 using G4BaseNtupleManager::FillNtupleSColu 78 using G4BaseNtupleManager::FillNtupleSColumn;
72 using G4BaseNtupleManager::AddNtupleRow; 79 using G4BaseNtupleManager::AddNtupleRow;
73 // Methods for ntuple with id > FirstNtupl << 80 // Methods for ntuple with id > FirstNtupleId (when more ntuples exist)
74 G4bool FillNtupleIColumn(G4int ntupleId, G << 81 virtual G4bool FillNtupleIColumn(G4int ntupleId, G4int columnId, G4int value) final;
75 G4bool FillNtupleFColumn(G4int ntupleId, G << 82 virtual G4bool FillNtupleFColumn(G4int ntupleId, G4int columnId, G4float value) final;
76 G4bool FillNtupleDColumn(G4int ntupleId, G << 83 virtual G4bool FillNtupleDColumn(G4int ntupleId, G4int columnId, G4double value) final;
77 G4bool FillNtupleSColumn(G4int ntupleId, G << 84 virtual G4bool FillNtupleSColumn(G4int ntupleId, G4int columnId,
78 G4bool AddNtupleRow(G4int ntupleId) overri << 85 const G4String& value) final;
>> 86 virtual G4bool AddNtupleRow(G4int ntupleId) override;
79 87
80 // Activation option 88 // Activation option
81 // 89 //
82 void SetActivation(G4bool activation) fina << 90 virtual void SetActivation(G4bool activation) final;
83 void SetActivation(G4int ntupleId, G4bool << 91 virtual void SetActivation(G4int ntupleId, G4bool activation) final;
84 G4bool GetActivation(G4int ntupleId) const << 92 virtual G4bool GetActivation(G4int ntupleId) const final;
85 <<
86 // New cycle option <<
87 void SetNewCycle(G4bool value) override; <<
88 G4bool GetNewCycle() const override; <<
89 93
90 // Access methods 94 // Access methods
91 NT* GetNtuple() const; << 95 TNTUPLE* GetNtuple() const;
92 NT* GetNtuple(G4int ntupleId) const; << 96 TNTUPLE* GetNtuple(G4int ntupleId) const;
>> 97 virtual G4int GetNofNtuples() const final;
>> 98 virtual G4int GetNofNtupleBookings() const override;
93 99
94 // Iterators 100 // Iterators
95 typename std::vector<NT*>::iterator BeginN << 101 typename std::vector<TNTUPLE*>::iterator BeginNtuple();
96 typename std::vector<NT*>::iterator EndNtu << 102 typename std::vector<TNTUPLE*>::iterator EndNtuple();
97 typename std::vector<NT*>::const_iterator << 103 typename std::vector<TNTUPLE*>::const_iterator BeginConstNtuple() const;
98 typename std::vector<NT*>::const_iterator << 104 typename std::vector<TNTUPLE*>::const_iterator EndConstNtuple() const;
99 << 105
100 // Data members 106 // Data members
101 std::vector<G4TNtupleDescription<NT, FT>*> << 107 std::vector<G4TNtupleDescription<TNTUPLE>*> fNtupleDescriptionVector;
102 std::vector<NT*> fNtupleVector; << 108 std::vector<TNTUPLE*> fNtupleVector;
103 const std::vector<G4NtupleBooking*>* fNtup <<
104 G4bool fNewCycle { false }; <<
105 109
106 private: 110 private:
107 // Methods << 111 // methods
108 << 112
109 // Fuctions which are specific to output t 113 // Fuctions which are specific to output type
110 // 114 //
111 virtual void CreateTNtupleFromBooking( 115 virtual void CreateTNtupleFromBooking(
112 G4TNtupleDescription<NT, F << 116 G4TNtupleDescription<TNTUPLE>* ntupleDescription) = 0;
113 117
114 virtual void FinishTNtuple( 118 virtual void FinishTNtuple(
115 G4TNtupleDescription<NT, F << 119 G4TNtupleDescription<TNTUPLE>* ntupleDescription,
116 G4bool fromBooking) = 0; 120 G4bool fromBooking) = 0;
117 121
118 // Common implementation 122 // Common implementation
119 // 123 //
120 124
121 G4TNtupleDescription<NT, FT>* GetNtupleDe << 125 G4TNtupleDescription<TNTUPLE>* GetNtupleDescriptionInFunction(G4int id,
122 std::s << 126 G4String function,
123 G4bool 127 G4bool warn = true) const;
124 NT* GetNtupleInFunction(G4int id, << 128 TNTUPLE* GetNtupleInFunction(G4int id,
125 std::string_view << 129 G4String function,
126 G4bool warn = tru << 130 G4bool warn = true) const;
127 131
128 // template functions for filling ntuple c << 132 // template functions for creating/filling ntuple columns
129 template <typename T> <<
130 G4bool FillNtupleTColumn(G4int ntupleId, G <<
131 133
132 // Static data members << 134 template <typename T>
133 static constexpr std::string_view fkClass << 135 G4int CreateNtupleTColumn(G4int ntupleId,
>> 136 const G4String& name, std::vector<T>* vector);
>> 137
>> 138 template <typename T>
>> 139 G4bool FillNtupleTColumn(G4int ntupleId, G4int columnId, const T& value);
134 }; 140 };
135 141
136 #include "G4TNtupleManager.icc" 142 #include "G4TNtupleManager.icc"
137 143
138 #endif 144 #endif
139 145
140 146