| 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 analysis file managers.
28 //
29 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4BaseFileManager_h
32 #define G4BaseFileManager_h 1
33
34 #include "G4AnalysisManagerState.hh"
35 #include "globals.hh"
36
37 #include <vector>
38
39 class G4BaseFileManager
40 {
41 public:
42 explicit G4BaseFileManager(const G4AnalysisManagerState& state);
43 G4BaseFileManager() = delete;
44 virtual ~G4BaseFileManager() = default;
45
46 virtual void SetCompressionLevel(G4int level);
47 // Set the compression level
48 virtual G4bool SetFileName(const G4String& fileName);
49 // Set the base file name (without extension)
50 virtual G4String GetFileType() const;
51 // Return the manager type (starts with a lowercase letter)
52 virtual G4bool HasCycles() const;
53 // Return true when the output supports writing the same object in a file
54 // multiple times.
55 // The default implementation returns false.
56
57 void AddFileName(const G4String& fileName);
58 // For handling multiple files
59 // Save file name in a vector if not yet present
60
61 G4int GetCompressionLevel() const;
62 // Return the compression level
63 G4String GetFileName() const;
64 // Return the base file name (without extension)
65 G4String GetFullFileName(const G4String& baseFileName = "",
66 G4bool isPerThread = true) const;
67 // Compose and return the full file name:
68 // - add _tN suffix to the file base name if isPerThread
69 // - add file extension if not present and available in state
70 const std::vector<G4String>& GetFileNames() const;
71 // Return the file names vector
72
73 G4String GetHnFileName(const G4String& hnType,
74 const G4String& hnName) const;
75 // Compose and return the histogram or profile specific file name:
76 // - add _hn_hnName suffix to the file base name
77 // - add file extension if not present
78
79 G4String GetHnFileName(const G4String& fileName,
80 G4int cycle = 0) const;
81 // Update Hn file name:
82 // - add _vN suffix to the base namer if cycle > 0
83
84 G4String GetNtupleFileName(const G4String& ntupleName,
85 G4int cycle = 0) const;
86 // Compose and return the ntuple specific file name:
87 // - add _nt_ntupleName suffix to the file base name
88 // - add _vN suffix if cycle > 0
89 // - add _tN suffix if called on thread worker
90 // - add file extension if not present
91
92 G4String GetNtupleFileName(G4int ntupleFileNumber,
93 G4int cycle = 0) const;
94 // Compose and return the ntuple specific file name:
95 // - add _mN suffix to the file base name
96 // - add _vN suffix if cycle > 0
97 // - add file extension if not present
98
99 G4String GetPlotFileName() const;
100 // Return the file name for batch plotting output
101
102 protected:
103 // Methods for verbose
104 void Message(G4int level,
105 const G4String& action,
106 const G4String& objectType,
107 const G4String& objectName = "",
108 G4bool success = true) const;
109
110 // Clear data
111 void ClearData();
112
113 // Data members
114 const G4AnalysisManagerState& fState;
115 G4int fCompressionLevel { 1 };
116 G4String fFileName; // to be changed in fDefaultFileName
117 std::vector<G4String> fFileNames;
118 };
119
120 inline void G4BaseFileManager::SetCompressionLevel(G4int level)
121 { fCompressionLevel = level; }
122
123 inline G4bool G4BaseFileManager::SetFileName(const G4String& fileName) {
124 // CHECK if still needed in this base class
125 fFileName = fileName;
126 return true;
127 }
128
129 inline G4bool G4BaseFileManager::HasCycles() const {
130 return false;
131 }
132
133 inline G4int G4BaseFileManager::GetCompressionLevel() const
134 { return fCompressionLevel; }
135
136 inline G4String G4BaseFileManager::GetFileName() const {
137 return fFileName;
138 }
139
140 inline const std::vector<G4String>& G4BaseFileManager::GetFileNames() const {
141 return fFileNames;
142 }
143
144 inline void G4BaseFileManager::Message(
145 G4int level, const G4String& action, const G4String& objectType,
146 const G4String& objectName, G4bool success) const
147 {
148 fState.Message(level, action, objectType, objectName, success);
149 }
150
151 inline void G4BaseFileManager::ClearData() {
152 fFileNames.clear();
153 }
154
155 #endif
156