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