| 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 ntuple Root file output,
28 // provides handling Root ntuple managers in parallel processing.
29
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31
32 #ifndef G4RootNtupleFileManager_h
33 #define G4RootNtupleFileManager_h 1
34
35 #include "G4VNtupleFileManager.hh"
36
37 #include <string_view>
38 #include <utility>
39
40 class G4RootFileManager;
41 class G4RootNtupleManager;
42 class G4RootPNtupleManager;
43 class G4VNtupleManager;
44 class G4NtupleBookingManager;
45
46 class G4RootNtupleFileManager : public G4VNtupleFileManager
47 {
48 friend class G4RootMpiNtupleFileManager;
49
50 public:
51 explicit G4RootNtupleFileManager(const G4AnalysisManagerState& state);
52 G4RootNtupleFileManager() = delete;
53 ~G4RootNtupleFileManager() override;
54
55 // MT/MPI
56 void SetNtupleMerging(G4bool mergeNtuples, G4int nofReducedNtupleFiles = 0) override;
57 void SetNtupleRowWise(G4bool rowWise, G4bool rowMode = true) override;
58 void SetBasketSize(unsigned int basketSize) override;
59 void SetBasketEntries(unsigned int basketEntries) override;
60
61 // virtual methods from base class
62 G4bool ActionAtOpenFile(const G4String& fileName) override;
63 G4bool ActionAtWrite() override;
64 G4bool ActionAtCloseFile() override;
65 G4bool Reset() override;
66 G4bool IsNtupleMergingSupported() const override;
67
68 std::shared_ptr<G4VNtupleManager> CreateNtupleManager() override;
69
70 void SetFileManager(std::shared_ptr<G4RootFileManager> fileManager);
71
72 G4NtupleMergeMode GetMergeMode() const override;
73 std::shared_ptr<G4RootNtupleManager> GetNtupleManager() const;
74
75 private:
76 // Static data members
77 static G4RootNtupleFileManager* fgMasterInstance;
78
79 void SetNtupleMergingMode(G4bool mergeNtuples, G4int nofNtupleFiles);
80 G4int GetNtupleFileNumber();
81 G4bool CloseNtupleFiles();
82
83 // Static data members
84 static constexpr std::string_view fkClass { "G4RootNtupleFileManager" };
85
86 // data members
87 G4bool fIsInitialized { false };
88 G4int fNofNtupleFiles { 0 };
89 G4bool fNtupleRowWise { false };
90 G4bool fNtupleRowMode { true };
91 G4NtupleMergeMode fNtupleMergeMode { G4NtupleMergeMode::kNone };
92 std::shared_ptr<G4RootNtupleManager> fNtupleManager { nullptr };
93 std::shared_ptr<G4RootPNtupleManager> fSlaveNtupleManager { nullptr };
94 std::shared_ptr<G4RootFileManager> fFileManager { nullptr };
95 };
96
97 inline void G4RootNtupleFileManager::SetFileManager(
98 std::shared_ptr<G4RootFileManager> fileManager)
99 {
100 fFileManager = std::move(fileManager);
101 }
102
103 inline G4NtupleMergeMode G4RootNtupleFileManager::GetMergeMode() const
104 { return fNtupleMergeMode; }
105
106 inline G4bool G4RootNtupleFileManager::IsNtupleMergingSupported() const
107 { return true; }
108
109 inline std::shared_ptr<G4RootNtupleManager> G4RootNtupleFileManager::GetNtupleManager() const
110 { return fNtupleManager; }
111
112 #endif
113