| 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 // The main manager for Root analysis.
28 // It delegates most of functions to the object specific managers.
29
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31
32 #ifndef G4GenericAnalysisManager_h
33 #define G4GenericAnalysisManager_h 1
34
35 #include "G4ToolsAnalysisManager.hh"
36 #include "G4THnManager.hh"
37 #include "G4AnalysisUtilities.hh"
38 #include "globals.hh"
39
40 #include <memory>
41 #include <string_view>
42 #include <vector>
43
44 class G4GenericAnalysisManager;
45 class G4GenericFileManager;
46 class G4HnInformation;
47 class G4VNtupleFileManager;
48 template <class T>
49 class G4ThreadLocalSingleton;
50
51 namespace tools {
52 class ntuple_bookig;
53 }
54
55 class G4GenericAnalysisManager : public G4ToolsAnalysisManager
56 {
57 friend class G4RootMpiAnalysisManager;
58 friend class G4ThreadLocalSingleton<G4GenericAnalysisManager>;
59
60 public:
61 ~G4GenericAnalysisManager() override;
62
63 // Static methods
64 static G4GenericAnalysisManager* Instance();
65 static G4bool IsInstance();
66
67 // MT/MPI
68 void SetNtupleMerging(G4bool mergeNtuples, G4int nofReducedNtupleFiles = 0) override;
69 void SetNtupleRowWise(G4bool rowWise, G4bool rowMode = true) override;
70 void SetBasketSize(unsigned int basketSize) override;
71 void SetBasketEntries(unsigned int basketEntries) override;
72
73 // write in an extra file
74 G4bool WriteH1(G4int id, const G4String& fileName);
75 G4bool WriteH2(G4int id, const G4String& fileName);
76 G4bool WriteH3(G4int id, const G4String& fileName);
77 G4bool WriteP1(G4int id, const G4String& fileName);
78 G4bool WriteP2(G4int id, const G4String& fileName);
79
80
81 // Access methods
82 // In difference from output specific managers, generic manager
83 // provides access only to ntuple_booking
84 tools::ntuple_booking* GetNtuple(G4bool warn = true,
85 G4bool onlyIfActive = true) const;
86 tools::ntuple_booking* GetNtuple(G4int ntupleId, G4bool warn = true,
87 G4bool onlyIfActive = true) const;
88
89 protected:
90 // Virtual methods from base class
91 G4bool OpenFileImpl(const G4String& fileName) override;
92 void SetDefaultFileTypeImpl(const G4String& value) override;
93 G4String GetDefaultFileTypeImpl() const override;
94 // File manager access
95 std::shared_ptr<G4VFileManager> GetFileManager(const G4String& fileName) final;
96
97 private:
98 G4GenericAnalysisManager();
99 // Methods
100 void CreateNtupleFileManager(const G4String& fileName);
101
102 // Static data members
103 inline static G4GenericAnalysisManager* fgMasterInstance { nullptr };
104 inline static G4ThreadLocal G4bool fgIsInstance { false };
105 static constexpr std::string_view fkClass { "G4GenericAnalysisManager" };
106
107 // Data members
108 std::shared_ptr<G4GenericFileManager> fFileManager { nullptr };
109 // add G4GenericNtupleManager
110 // this class will be analogic to file managers but with ntuples
111 std::shared_ptr<G4VNtupleFileManager> fNtupleFileManager { nullptr };
112
113 // Data members
114 G4bool fIsNtupleMergingSet { false };
115 G4int fNofNtupleFiles { 0 };
116 G4bool fMergeNtuples { false };
117 G4bool fNtupleRowWise { false };
118 G4bool fNtupleRowMode { true };
119 unsigned int fBasketSize { G4Analysis::kDefaultBasketSize };
120 unsigned int fBasketEntries { G4Analysis::kDefaultBasketEntries };
121 };
122
123 #include "G4GenericAnalysisManager.icc"
124
125 #endif
126