| 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 // Base class for File manager.
28 //
29 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4VFileManager_h
32 #define G4VFileManager_h 1
33
34 #include "G4BaseFileManager.hh"
35 #include "G4VTHnFileManager.hh"
36 #include "globals.hh"
37
38 #include <memory>
39 #include <string_view>
40
41 namespace tools {
42 namespace histo {
43 class h1d;
44 class h2d;
45 class h3d;
46 class p1d;
47 class p2d;
48 }
49 }
50
51 class G4VFileManager : public G4BaseFileManager
52 {
53 public:
54 explicit G4VFileManager(const G4AnalysisManagerState& state);
55 G4VFileManager() = delete;
56 ~G4VFileManager() override = default;
57
58 // Method to open default file
59 virtual G4bool OpenFile(const G4String& fileName) = 0;
60
61 // Methods applied to file per name
62 virtual G4bool CreateFile(const G4String& fileName) = 0;
63 virtual G4bool WriteFile(const G4String& fileName) = 0;
64 virtual G4bool CloseFile(const G4String& fileName) = 0;
65 virtual G4bool SetIsEmpty(const G4String& fileName, G4bool isEmpty) = 0;
66
67 // Methods applied to all registered files
68 virtual G4bool OpenFiles() = 0;
69 virtual G4bool WriteFiles() = 0;
70 virtual G4bool CloseFiles() = 0;
71 virtual G4bool DeleteEmptyFiles() = 0;
72
73 // Clear all data
74 virtual void Clear() = 0;
75
76 // Methods for handling files and directories names
77 G4bool SetFileName(const G4String& fileName) final;
78 virtual G4bool SetHistoDirectoryName(const G4String& dirName);
79 virtual G4bool SetNtupleDirectoryName(const G4String& dirName);
80
81 void LockDirectoryNames();
82 void UnlockDirectoryNames();
83
84 G4bool IsOpenFile() const;
85 G4String GetHistoDirectoryName() const;
86 G4String GetNtupleDirectoryName() const;
87 G4int GetCycle() const;
88
89 // Access to helpers
90 template <typename HT>
91 std::shared_ptr<G4VTHnFileManager<HT>> GetHnFileManager() const;
92
93 protected:
94 // Static data members
95 static constexpr std::string_view fkClass { "G4VFileManager" };
96
97 // Data members
98 G4String fHistoDirectoryName;
99 G4String fNtupleDirectoryName;
100 G4bool fIsOpenFile { false };
101 G4bool fLockDirectoryNames { false };
102
103 // FileManagers per object type
104 std::shared_ptr<G4VTHnFileManager<tools::histo::h1d>> fH1FileManager { nullptr };
105 std::shared_ptr<G4VTHnFileManager<tools::histo::h2d>> fH2FileManager { nullptr };
106 std::shared_ptr<G4VTHnFileManager<tools::histo::h3d>> fH3FileManager { nullptr };
107 std::shared_ptr<G4VTHnFileManager<tools::histo::p1d>> fP1FileManager { nullptr };
108 std::shared_ptr<G4VTHnFileManager<tools::histo::p2d>> fP2FileManager { nullptr };
109 };
110
111 // inline functions
112
113 inline void G4VFileManager::LockDirectoryNames()
114 { fLockDirectoryNames = true; }
115
116 inline void G4VFileManager::UnlockDirectoryNames()
117 { fLockDirectoryNames = false; }
118
119 inline G4bool G4VFileManager::IsOpenFile() const
120 { return fIsOpenFile; }
121
122 inline G4String G4VFileManager::GetHistoDirectoryName() const
123 { return fHistoDirectoryName; }
124
125 inline G4String G4VFileManager::GetNtupleDirectoryName() const
126 { return fNtupleDirectoryName; }
127
128 inline G4int G4VFileManager::GetCycle() const
129 { return fState.GetCycle(); }
130
131 template <>
132 inline
133 std::shared_ptr<G4VTHnFileManager<tools::histo::h1d>>
134 G4VFileManager::GetHnFileManager<tools::histo::h1d>() const
135 { return fH1FileManager; }
136
137 template <>
138 inline
139 std::shared_ptr<G4VTHnFileManager<tools::histo::h2d>>
140 G4VFileManager::GetHnFileManager<tools::histo::h2d>() const
141 { return fH2FileManager; }
142
143 template <>
144 inline
145 std::shared_ptr<G4VTHnFileManager<tools::histo::h3d>>
146 G4VFileManager::GetHnFileManager<tools::histo::h3d>() const
147 { return fH3FileManager; }
148
149 template <>
150 inline
151 std::shared_ptr<G4VTHnFileManager<tools::histo::p1d>>
152 G4VFileManager::GetHnFileManager<tools::histo::p1d>() const
153 { return fP1FileManager; }
154
155 template <>
156 inline
157 std::shared_ptr<G4VTHnFileManager<tools::histo::p2d>>
158 G4VFileManager::GetHnFileManager<tools::histo::p2d>() const
159 { return fP2FileManager; }
160
161 #endif
162