Geant4  10.03
G4BaseFileManager.hh
Go to the documentation of this file.
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 // $Id: G4BaseFileManager.hh 70604 2013-06-03 11:27:06Z ihrivnac $
27 
28 // Base class for analysis file managers.
29 //
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31 
32 #ifndef G4BaseFileManager_h
33 #define G4BaseFileManager_h 1
34 
36 #include "globals.hh"
37 
39 {
40  public:
41  explicit G4BaseFileManager(const G4AnalysisManagerState& state);
42  virtual ~G4BaseFileManager();
43 
44  virtual G4bool SetFileName(const G4String& fileName);
45  // Set the base file name (without extension)
46  // If the current file name is already in use
47  // setting is not performed and false is returned
48 
49  G4String GetFileName() const;
50  // Return the base file name (without extension)
51 
52  G4String GetFullFileName(const G4String& baseFileName = "",
53  G4bool isPerThread = true) const;
54  // Compose and return the full file name:
55  // - add _tN suffix to the file base name if isPerThread
56  // - add file extension if not present
57 
58  G4String GetHnFileName(const G4String& hnType,
59  const G4String& hnName) const;
60  // Compose and return the histogram or profile specific file name:
61  // - add _hn_hnName suffix to the file base name
62  // - add file extension if not present
63 
64  G4String GetNtupleFileName(const G4String& ntupleName) const;
65  // Compose and return the ntuple specific file name:
66  // - add _nt_ntupleName suffix to the file base name
67  // - add _tN suffix if called on thread worker
68  // - add file extension if not present
69 
70  G4String GetNtupleFileName(G4int ntupleFileNumber) const;
71  // Compose and return the ntuple specific file name:
72  // - add _mN suffix to the file base name
73  // - add file extension if not present
74 
75  G4String GetPlotFileName() const;
76  // Return the file name for batch plotting output
77 
78  G4String GetFileType() const;
79  // Return the manager file type (starts with a lowercase letter)
80 
81  protected:
82  // utility function
84 
85  // data members
88 };
89 
91  fFileName = fileName;
92  return true;
93 }
94 
96  return fFileName;
97 }
98 
99 #endif
100 
virtual G4bool SetFileName(const G4String &fileName)
const G4AnalysisManagerState & fState
G4String GetNtupleFileName(const G4String &ntupleName) const
G4String GetPlotFileName() const
const char * name(G4int ptype)
G4String GetHnFileName(const G4String &hnType, const G4String &hnName) const
int G4int
Definition: G4Types.hh:78
virtual ~G4BaseFileManager()
G4String GetFileType() const
bool G4bool
Definition: G4Types.hh:79
G4String TakeOffExtension(G4String &name) const
G4BaseFileManager(const G4AnalysisManagerState &state)
G4String GetFileName() const
G4String GetFullFileName(const G4String &baseFileName="", G4bool isPerThread=true) const