| 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> 39 #include <string_view>
40 40
41 // NT - ntuple type, FT - file type 41 // NT - ntuple type, FT - file type
42 template <typename NT, typename FT> 42 template <typename NT, typename FT>
43 class G4TNtupleManager : public G4BaseNtupleMa 43 class G4TNtupleManager : public G4BaseNtupleManager {
44 44
45 public: 45 public:
46 explicit G4TNtupleManager(const G4Analysis 46 explicit G4TNtupleManager(const G4AnalysisManagerState& state);
47 G4TNtupleManager() = delete; 47 G4TNtupleManager() = delete;
48 ~G4TNtupleManager() override; 48 ~G4TNtupleManager() override;
49 49
50 protected: 50 protected:
51 // Methods to manipulate ntuples 51 // Methods to manipulate ntuples
52 G4int CreateNtuple(G4NtupleBooking* ntuple 52 G4int CreateNtuple(G4NtupleBooking* ntupleBooking) override;
53 53
54 virtual void CreateNtuplesFromBooking( 54 virtual void CreateNtuplesFromBooking(
55 const std::vector<G4NtupleB 55 const std::vector<G4NtupleBooking*>& ntupleBookings);
56 56
57 virtual G4bool Reset(); 57 virtual G4bool Reset();
58 void Clear() override; 58 void Clear() override;
59 59
60 // Method to delete selected ntuple <<
61 G4bool Delete(G4int id) override; <<
62 <<
63 // Methods to create ntuples 60 // Methods to create ntuples
64 // are implemented in G4NtupleBookingManag 61 // are implemented in G4NtupleBookingManager base class
65 62
66 // Methods to fill ntuples 63 // Methods to fill ntuples
67 // Methods for ntuple with id = FirstNtupl 64 // Methods for ntuple with id = FirstNtupleId (from base class)
68 using G4BaseNtupleManager::FillNtupleIColu 65 using G4BaseNtupleManager::FillNtupleIColumn;
69 using G4BaseNtupleManager::FillNtupleFColu 66 using G4BaseNtupleManager::FillNtupleFColumn;
70 using G4BaseNtupleManager::FillNtupleDColu 67 using G4BaseNtupleManager::FillNtupleDColumn;
71 using G4BaseNtupleManager::FillNtupleSColu 68 using G4BaseNtupleManager::FillNtupleSColumn;
72 using G4BaseNtupleManager::AddNtupleRow; 69 using G4BaseNtupleManager::AddNtupleRow;
73 // Methods for ntuple with id > FirstNtupl 70 // Methods for ntuple with id > FirstNtupleId (when more ntuples exist)
74 G4bool FillNtupleIColumn(G4int ntupleId, G 71 G4bool FillNtupleIColumn(G4int ntupleId, G4int columnId, G4int value) final;
75 G4bool FillNtupleFColumn(G4int ntupleId, G 72 G4bool FillNtupleFColumn(G4int ntupleId, G4int columnId, G4float value) final;
76 G4bool FillNtupleDColumn(G4int ntupleId, G 73 G4bool FillNtupleDColumn(G4int ntupleId, G4int columnId, G4double value) final;
77 G4bool FillNtupleSColumn(G4int ntupleId, G 74 G4bool FillNtupleSColumn(G4int ntupleId, G4int columnId, const G4String& value) final;
78 G4bool AddNtupleRow(G4int ntupleId) overri 75 G4bool AddNtupleRow(G4int ntupleId) override;
79 76
80 // Activation option 77 // Activation option
81 // 78 //
82 void SetActivation(G4bool activation) fina 79 void SetActivation(G4bool activation) final;
83 void SetActivation(G4int ntupleId, G4bool 80 void SetActivation(G4int ntupleId, G4bool activation) final;
84 G4bool GetActivation(G4int ntupleId) const 81 G4bool GetActivation(G4int ntupleId) const final;
85 82
86 // New cycle option 83 // New cycle option
87 void SetNewCycle(G4bool value) override; 84 void SetNewCycle(G4bool value) override;
88 G4bool GetNewCycle() const override; 85 G4bool GetNewCycle() const override;
89 86
90 // Access methods 87 // Access methods
91 NT* GetNtuple() const; 88 NT* GetNtuple() const;
92 NT* GetNtuple(G4int ntupleId) const; 89 NT* GetNtuple(G4int ntupleId) const;
>> 90 G4int GetNofNtuples() const final;
>> 91
>> 92 // List ntuples
>> 93 G4bool List(std::ostream& output, G4bool onlyIfActive = true) final;
93 94
94 // Iterators 95 // Iterators
95 typename std::vector<NT*>::iterator BeginN 96 typename std::vector<NT*>::iterator BeginNtuple();
96 typename std::vector<NT*>::iterator EndNtu 97 typename std::vector<NT*>::iterator EndNtuple();
97 typename std::vector<NT*>::const_iterator 98 typename std::vector<NT*>::const_iterator BeginConstNtuple() const;
98 typename std::vector<NT*>::const_iterator 99 typename std::vector<NT*>::const_iterator EndConstNtuple() const;
99 100
100 // Data members 101 // Data members
101 std::vector<G4TNtupleDescription<NT, FT>*> 102 std::vector<G4TNtupleDescription<NT, FT>*> fNtupleDescriptionVector;
102 std::vector<NT*> fNtupleVector; 103 std::vector<NT*> fNtupleVector;
103 const std::vector<G4NtupleBooking*>* fNtup 104 const std::vector<G4NtupleBooking*>* fNtupleBookingVector { nullptr };
104 G4bool fNewCycle { false }; 105 G4bool fNewCycle { false };
105 106
106 private: 107 private:
107 // Methods 108 // Methods
108 109
109 // Fuctions which are specific to output t 110 // Fuctions which are specific to output type
110 // 111 //
111 virtual void CreateTNtupleFromBooking( 112 virtual void CreateTNtupleFromBooking(
112 G4TNtupleDescription<NT, F 113 G4TNtupleDescription<NT, FT>* ntupleDescription) = 0;
113 114
114 virtual void FinishTNtuple( 115 virtual void FinishTNtuple(
115 G4TNtupleDescription<NT, F 116 G4TNtupleDescription<NT, FT>* ntupleDescription,
116 G4bool fromBooking) = 0; 117 G4bool fromBooking) = 0;
117 118
118 // Common implementation 119 // Common implementation
119 // 120 //
120 121
121 G4TNtupleDescription<NT, FT>* GetNtupleDe 122 G4TNtupleDescription<NT, FT>* GetNtupleDescriptionInFunction(G4int id,
122 std::s 123 std::string_view function,
123 G4bool 124 G4bool warn = true) const;
124 NT* GetNtupleInFunction(G4int id, 125 NT* GetNtupleInFunction(G4int id,
125 std::string_view 126 std::string_view function,
126 G4bool warn = tru 127 G4bool warn = true) const;
127 128
128 // template functions for filling ntuple c 129 // template functions for filling ntuple columns
129 template <typename T> 130 template <typename T>
130 G4bool FillNtupleTColumn(G4int ntupleId, G 131 G4bool FillNtupleTColumn(G4int ntupleId, G4int columnId, const T& value);
131 132
132 // Static data members 133 // Static data members
133 static constexpr std::string_view fkClass 134 static constexpr std::string_view fkClass { "G4TNtupleManager<NT,FT>" };
134 }; 135 };
135 136
136 #include "G4TNtupleManager.icc" 137 #include "G4TNtupleManager.icc"
137 138
138 #endif 139 #endif
139 140
140 141