| 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 manager for Root output file operations.
28
29 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4GenericFileManager_h
32 #define G4GenericFileManager_h 1
33
34 #include "G4VFileManager.hh"
35 #include "G4AnalysisUtilities.hh"
36 #include "globals.hh"
37
38 #include <vector>
39 #include <memory>
40 #include <string_view>
41
42 class G4HnInformation;
43 class G4VNtupleFileManager;
44
45 class G4CsvFileManager;
46 #ifdef TOOLS_USE_HDF5
47 class G4Hdf5FileManager;
48 #endif
49 class G4RootFileManager;
50 class G4XmlFileManager;
51
52 class G4GenericFileManager : public G4VFileManager
53 {
54 public:
55 explicit G4GenericFileManager(const G4AnalysisManagerState& state);
56 ~G4GenericFileManager() override = default;
57
58 // Method to manipulate a default file
59 G4bool OpenFile(const G4String& fileName) final;
60
61 // Methods applied to all registered files
62 G4bool OpenFiles() final;
63 G4bool WriteFiles() final;
64 G4bool CloseFiles() final;
65 G4bool DeleteEmptyFiles() final;
66
67 // Clear all data
68 void Clear() final;
69
70 // Methods applied to file per name
71 G4bool CreateFile(const G4String& fileName) final;
72 G4bool WriteFile(const G4String& fileName) final;
73 G4bool CloseFile(const G4String& fileName) final;
74 G4bool SetIsEmpty(const G4String& fileName, G4bool isEmpty) final;
75
76 G4bool SetHistoDirectoryName(const G4String& dirName) override;
77 G4bool SetNtupleDirectoryName(const G4String& dirName) override;
78 void SetCompressionLevel(G4int level) override;
79
80 G4String GetFileType() const final { return ""; }
81
82 // Set default output type (backward compatibility)
83 // this type will be used for file names without extension
84 void SetDefaultFileType(const G4String& value);
85 G4String GetDefaultFileType() const;
86
87 // Get file manager for a specific output type
88 std::shared_ptr<G4VFileManager> GetFileManager(const G4String& fileName);
89
90 template <typename HT>
91 G4bool WriteTExtra(const G4String& fileName, HT* ht, const G4String& htName);
92
93 // Methods
94 std::shared_ptr<G4VNtupleFileManager> CreateNtupleFileManager(G4AnalysisOutput output);
95
96 private:
97 // Methods
98 void CreateFileManager(G4AnalysisOutput output);
99 std::shared_ptr<G4VFileManager> GetFileManager(G4AnalysisOutput output) const;
100
101 // Static data members
102 static constexpr std::string_view fkClass { "G4GenericFileManager" };
103 // inline static const G4String fgkDefaultFileType { "root" };
104 // inline static const G4String fgkDefaultFileType { "undefined" };
105
106 // Data members
107 G4String fDefaultFileType;
108 std::shared_ptr<G4VFileManager> fDefaultFileManager { nullptr };
109 std::vector<std::shared_ptr<G4VFileManager>> fFileManagers {
110 // Csv, Hdf5, Root, Xml
111 nullptr, nullptr, nullptr, nullptr
112 };
113 std::shared_ptr<G4CsvFileManager> fCsvFileManager { nullptr };
114 #ifdef TOOLS_USE_HDF5
115 std::shared_ptr<G4Hdf5FileManager> fHdf5FileManager { nullptr };
116 #endif
117 std::shared_ptr<G4RootFileManager> fRootFileManager { nullptr };
118 std::shared_ptr<G4XmlFileManager> fXmlFileManager { nullptr };
119 G4bool fHdf5Warn { true };
120 };
121
122 #include "G4GenericFileManager.icc"
123
124 #endif
125
126