| 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 Hdf5 file output operations.
28
29 // Author: Ivana Hrivnacova, 20/07/2017 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4Hdf5FileManager_h
32 #define G4Hdf5FileManager_h 1
33
34 #include "G4VTFileManager.hh"
35 #include "G4AnalysisUtilities.hh"
36 #include "globals.hh"
37
38 #include "toolx/hdf5/ntuple" // for hid_t
39
40 #include <memory>
41 #include <tuple>
42 #include <string_view>
43
44 using G4Hdf5File = std::tuple<hid_t, hid_t, hid_t>;
45 using Hdf5NtupleDescription = G4TNtupleDescription<toolx::hdf5::ntuple, G4Hdf5File>;
46
47 class G4Hdf5FileManager : public G4VTFileManager<G4Hdf5File>
48 {
49 public:
50 explicit G4Hdf5FileManager(const G4AnalysisManagerState& state);
51 G4Hdf5FileManager() = delete;
52 ~G4Hdf5FileManager() override = default;
53
54 using G4BaseFileManager::GetNtupleFileName;
55 using G4VTFileManager<G4Hdf5File>::WriteFile;
56 using G4VTFileManager<G4Hdf5File>::CloseFile;
57
58 // Methods to manipulate output files
59 G4bool OpenFile(const G4String& fileName) final;
60
61 G4String GetFileType() const final { return "hdf5"; }
62
63 // Specific methods for files per objects
64 G4bool CreateNtupleFile(Hdf5NtupleDescription* ntupleDescription);
65 G4bool CloseNtupleFile(Hdf5NtupleDescription* ntupleDescription);
66
67 // Set methods
68 void SetBasketSize(unsigned int basketSize);
69
70 // Get methods
71 hid_t GetHistoDirectory() const;
72 hid_t GetNtupleDirectory() const;
73 unsigned int GetBasketSize() const;
74
75 protected:
76 // // Methods derived from base class
77 std::shared_ptr<G4Hdf5File> CreateFileImpl(const G4String& fileName) final;
78 G4bool WriteFileImpl(std::shared_ptr<G4Hdf5File> file) final;
79 G4bool CloseFileImpl(std::shared_ptr<G4Hdf5File> file) final;
80
81 private:
82 hid_t CreateDirectory(hid_t& file, const G4String& directoryName,
83 const G4String& objectType);
84 G4String GetNtupleFileName(Hdf5NtupleDescription* ntupleDescription);
85
86 // Static data members
87 static constexpr std::string_view fkClass { "G4Hdf5FileManager" };
88 inline static const G4String fgkDefaultDirectoryName { "default" };
89
90 // data members
91 unsigned int fBasketSize { G4Analysis::kDefaultBasketSize };
92 };
93
94 // inline functions
95
96 //_____________________________________________________________________________
97 inline void G4Hdf5FileManager::SetBasketSize(unsigned int basketSize)
98 { fBasketSize = basketSize; }
99
100 //_____________________________________________________________________________
101 inline unsigned int G4Hdf5FileManager::GetBasketSize() const
102 { return fBasketSize; }
103
104 #endif
105