| 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 Csv output file operations.
28
29 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4CsvFileManager_h
32 #define G4CsvFileManager_h 1
33
34 #include "G4VTFileManager.hh"
35 #include "G4TNtupleDescription.hh"
36 #include "globals.hh"
37
38 #include "tools/wcsv_ntuple"
39
40 #include <string_view>
41
42 // Type aliases
43 using CsvNtupleDescription = G4TNtupleDescription<tools::wcsv::ntuple, std::ofstream>;
44
45 class G4CsvFileManager : public G4VTFileManager<std::ofstream>
46 {
47 public:
48 explicit G4CsvFileManager(const G4AnalysisManagerState& state);
49 G4CsvFileManager() = delete;
50 ~G4CsvFileManager() override = default;
51
52 using G4BaseFileManager::GetNtupleFileName;
53 using G4VTFileManager<std::ofstream>::WriteFile;
54 using G4VTFileManager<std::ofstream>::CloseFile;
55
56 // Methods to manipulate output files
57 G4bool OpenFile(const G4String& fileName) final;
58
59 G4bool SetHistoDirectoryName(const G4String& dirName) final;
60 G4bool SetNtupleDirectoryName(const G4String& dirName) final;
61
62 G4String GetFileType() const final { return "csv"; }
63
64 // Specific methods for files per objects
65 G4bool NotifyNtupleFile(CsvNtupleDescription* ntupleDescription);
66 G4bool CreateNtupleFile(CsvNtupleDescription* ntupleDescription);
67 G4bool CloseNtupleFile(CsvNtupleDescription* ntupleDescription);
68
69 G4bool IsHistoDirectory() const;
70 G4bool IsNtupleDirectory() const;
71
72 protected:
73 // Methods derived from templated base class
74 std::shared_ptr<std::ofstream> CreateFileImpl(const G4String& fileName) final;
75 G4bool WriteFileImpl(std::shared_ptr<std::ofstream> file) final;
76 G4bool CloseFileImpl(std::shared_ptr<std::ofstream> file) final;
77
78 private:
79 // Utility method
80 G4String GetNtupleFileName(CsvNtupleDescription* ntupleDescription);
81
82 // Static data members
83 static constexpr std::string_view fkClass { "G4CsvFileManager" };
84
85 // Data members
86 G4bool fIsHistoDirectory { false };
87 G4bool fIsNtupleDirectory { false };
88 };
89
90 // inline functions
91
92 inline G4bool G4CsvFileManager::IsHistoDirectory() const
93 { return fIsHistoDirectory; }
94
95 inline G4bool G4CsvFileManager::IsNtupleDirectory() const
96 { return fIsNtupleDirectory; }
97
98 #endif
99