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