| 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 // Manager class for Root ntuples.
28 // It implements functions specific to Root ntuples in sequential mode.
29 //
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31
32 #ifndef G4RootNtupleManager_h
33 #define G4RootNtupleManager_h 1
34
35 #include "G4TNtupleManager.hh"
36 #include "G4RootFileDef.hh"
37 #include "globals.hh"
38
39 #include "tools/wroot/ntuple"
40
41 #include <string_view>
42
43 class G4RootMainNtupleManager;
44 class G4NtupleBookingManager;
45 class G4RootFileManager;
46
47 // Types alias
48 using RootNtupleDescription = G4TNtupleDescription<tools::wroot::ntuple, G4RootFile>;
49
50 // template specializations used by this class defined below
51
52 template <>
53 template <>
54 G4bool G4TNtupleManager<tools::wroot::ntuple, G4RootFile>::FillNtupleTColumn(
55 G4int ntupleId, G4int columnId, const std::string& value);
56
57
58 class G4RootNtupleManager : public G4TNtupleManager<tools::wroot::ntuple,
59 G4RootFile>
60 {
61 friend class G4RootAnalysisManager;
62 friend class G4RootMainNtupleManager;
63 friend class G4RootNtupleFileManager;
64 friend class G4RootMpiNtupleFileManager;
65 friend class G4RootMpiNtupleManager;
66
67 public:
68 G4RootNtupleManager(const G4AnalysisManagerState& state,
69 const std::shared_ptr<G4NtupleBookingManager>& bookingManger,
70 G4int nofMainManagers, G4int nofReducedFiles,
71 G4bool rowWise, G4bool rowMode);
72 G4RootNtupleManager() = delete;
73 ~G4RootNtupleManager() override = default;
74
75 private:
76 // Methods from the templated base class
77 void CreateTNtupleFromBooking(RootNtupleDescription* ntupleDescription) final;
78 void FinishTNtuple(RootNtupleDescription* ntupleDescription, G4bool fromBooking) final;
79 G4bool Reset() final;
80 void Clear() final;
81 G4bool Delete(G4int id) final;
82 virtual G4bool Merge();
83
84 // Set functions
85 void SetFileManager(const std::shared_ptr<G4RootFileManager>& fileManager);
86 void SetNtupleFile(std::shared_ptr<G4RootFile> file);
87 void SetNtupleRowWise(G4bool rowWise, G4bool rowMode);
88
89 // New cycle option
90 void SetNewCycle(G4bool value) final;
91
92 // Access functions
93 const std::vector<RootNtupleDescription*>& GetNtupleDescriptionVector() const;
94 std::shared_ptr<G4RootMainNtupleManager> GetMainNtupleManager(G4int index) const;
95 unsigned int GetBasketSize() const;
96 unsigned int GetBasketEntries() const;
97
98 // Static data members
99 static constexpr std::string_view fkClass { "G4RootNtupleManager" };
100
101 // Rata members
102 std::shared_ptr<G4RootFileManager> fFileManager { nullptr };
103 std::vector<std::shared_ptr<G4RootMainNtupleManager>> fMainNtupleManagers;
104 std::shared_ptr<G4RootFile> fNtupleFile { nullptr };
105 G4bool fRowWise;
106 G4bool fRowMode;
107 };
108
109 #include "G4RootNtupleManager.icc"
110
111 #endif
112
113
114