| 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 for Root main ntuple management.
28 //
29 // Author: Ivana Hrivnacova, 04/10/2016 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4RootMainNtupleManager_h
32 #define G4RootMainNtupleManager_h 1
33
34 #include "G4BaseAnalysisManager.hh"
35 #include "G4NtupleBookingManager.hh"
36 #include "G4RootFileDef.hh"
37 #include "G4RootNtupleManager.hh"
38 #include "G4TNtupleDescription.hh"
39 #include "globals.hh"
40
41 #include <string_view>
42 #include <utility>
43 #include <vector>
44
45 class G4RootFileManager;
46 class G4RootNtupleManager;
47 class G4NtupleBookingManager;
48
49 namespace tools {
50 namespace wroot {
51 class ntuple;
52 }
53 }
54
55 // Types alias
56 using RootNtupleDescription = G4TNtupleDescription<tools::wroot::ntuple, G4RootFile>;
57 using RootMainNtupleDescription = std::pair<RootNtupleDescription*, std::shared_ptr<G4RootFile>>;
58
59 class G4RootMainNtupleManager : public G4BaseAnalysisManager
60 {
61 friend class G4RootPNtupleManager;
62 friend class G4RootNtupleManager;
63
64 public:
65 G4RootMainNtupleManager(
66 G4RootNtupleManager* ntupleBuilder,
67 std::shared_ptr<G4NtupleBookingManager> bookingManager,
68 G4bool rowWise, G4int fileNumber,
69 const G4AnalysisManagerState& state);
70 G4RootMainNtupleManager() = delete;
71 ~G4RootMainNtupleManager() override = default;
72
73 void CreateNtuplesFromBooking();
74
75 protected:
76 // Methods to manipulate ntuples
77 void CreateNtuple(RootNtupleDescription* ntupleDescription, G4bool warn = true);
78 G4bool Delete(G4int id);
79 G4bool Merge();
80 G4bool Reset();
81 void ClearData();
82
83 // Set/get methods
84 void SetFileManager(std::shared_ptr<G4RootFileManager> fileManager);
85 void SetRowWise(G4bool rowWise);
86 std::shared_ptr<G4RootFile> GetNtupleFile(RootNtupleDescription* ntupleDescription) const;
87
88 // New cycle option
89 void SetNewCycle(G4bool value);
90 G4bool GetNewCycle() const;
91
92 // Access functions
93 const std::vector<tools::wroot::ntuple*>& GetNtupleVector()
94 { return fNtupleVector; }
95 unsigned int GetBasketEntries() const;
96
97 private:
98 // Static data members
99 static constexpr std::string_view fkClass { "G4RootMainNtupleManager" };
100
101 // Methods
102 G4int CreateNtupleFromBooking(G4NtupleBooking* ntupleBooking,
103 std::shared_ptr<G4RootFile> ntupleFile);
104
105 // Data members
106 G4RootNtupleManager* fNtupleBuilder { nullptr };
107 std::shared_ptr<G4NtupleBookingManager> fBookingManager { nullptr };
108 std::shared_ptr<G4RootFileManager> fFileManager { nullptr };
109 G4bool fRowWise;
110 G4int fFileNumber;
111 std::vector<tools::wroot::ntuple*> fNtupleVector;
112 std::vector<RootMainNtupleDescription> fNtupleDescriptionVector;
113 G4bool fNewCycle { false };
114 };
115
116 inline void G4RootMainNtupleManager::SetFileManager(
117 std::shared_ptr<G4RootFileManager> fileManager)
118 {
119 fFileManager = std::move(fileManager);
120 }
121
122 inline void G4RootMainNtupleManager::SetRowWise(G4bool rowWise)
123 { fRowWise = rowWise; }
124
125 inline unsigned int G4RootMainNtupleManager::GetBasketEntries() const
126 { return fNtupleBuilder->GetBasketEntries(); }
127
128 inline void G4RootMainNtupleManager::SetNewCycle(G4bool value)
129 { fNewCycle = value; }
130
131 inline G4bool G4RootMainNtupleManager::GetNewCycle() const
132 { return fNewCycle; }
133
134 #endif
135