Geant4-11
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes
G4VTFileManager< FT > Class Template Referenceabstract

#include <G4VTFileManager.hh>

Inheritance diagram for G4VTFileManager< FT >:
G4VFileManager G4TFileManager< FT > G4BaseFileManager

Public Member Functions

void AddFileName (const G4String &fileName)
 
virtual void Clear () final
 
void ClearData ()
 
virtual G4bool CloseFile (const G4String &fileName) final
 
virtual G4bool CloseFile (const G4String &fileName)=0
 
virtual G4bool CloseFiles () final
 
G4bool CloseTFile (const G4String &fileName)
 
virtual G4bool CreateFile (const G4String &fileName) final
 
std::shared_ptr< FT > CreateTFile (const G4String &fileName)
 
virtual G4bool DeleteEmptyFiles () final
 
 G4VTFileManager (const G4AnalysisManagerState &state)
 
std::shared_ptr< FT > GetFile () const
 
G4String GetFileName () const
 
const std::vector< G4String > & GetFileNames () const
 
virtual G4String GetFileType () const
 
G4String GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const
 
G4String GetHistoDirectoryName () const
 
template<typename HT >
std::shared_ptr< G4VTHnFileManager< HT > > GetHnFileManager () const
 
G4String GetHnFileName (const G4String &hnType, const G4String &hnName) const
 
G4String GetNtupleDirectoryName () const
 
G4String GetNtupleFileName (const G4String &ntupleName) const
 
G4String GetNtupleFileName (G4int ntupleFileNumber) const
 
G4String GetPlotFileName () const
 
std::shared_ptr< FT > GetTFile (const G4String &fileName, G4bool warn=true) const
 
G4bool IsOpenFile () const
 
void LockDirectoryNames ()
 
virtual G4bool OpenFile (const G4String &fileName)=0
 
G4bool OpenFiles ()
 
virtual G4bool SetFileName (const G4String &fileName) final
 
virtual G4bool SetHistoDirectoryName (const G4String &dirName)
 
virtual G4bool SetIsEmpty (const G4String &fileName, G4bool isEmpty) final
 
virtual G4bool SetNtupleDirectoryName (const G4String &dirName)
 
void UnlockDirectoryNames ()
 
virtual G4bool WriteFile (const G4String &fileName) final
 
virtual G4bool WriteFile (const G4String &fileName)=0
 
virtual G4bool WriteFiles () final
 
G4bool WriteTFile (const G4String &fileName)
 
virtual ~G4VTFileManager ()=default
 

Protected Member Functions

virtual G4bool CloseFileImpl (std::shared_ptr< FT > file)=0
 
virtual std::shared_ptr< FT > CreateFileImpl (const G4String &fileName)=0
 
void Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
 
virtual G4bool WriteFileImpl (std::shared_ptr< FT > file)=0
 

Protected Attributes

std::shared_ptr< FT > fFile { nullptr }
 
G4String fFileName
 
std::vector< G4StringfFileNames
 
std::shared_ptr< G4VTHnFileManager< tools::histo::h1d > > fH1FileManager { nullptr }
 
std::shared_ptr< G4VTHnFileManager< tools::histo::h2d > > fH2FileManager { nullptr }
 
std::shared_ptr< G4VTHnFileManager< tools::histo::h3d > > fH3FileManager { nullptr }
 
G4String fHistoDirectoryName
 
G4bool fIsOpenFile { false }
 
G4bool fLockDirectoryNames { false }
 
G4String fNtupleDirectoryName
 
std::shared_ptr< G4VTHnFileManager< tools::histo::p1d > > fP1FileManager { nullptr }
 
std::shared_ptr< G4VTHnFileManager< tools::histo::p2d > > fP2FileManager { nullptr }
 
const G4AnalysisManagerStatefState
 

Static Protected Attributes

static constexpr std::string_view fkClass { "G4VFileManager" }
 

Private Member Functions

G4bool CloseTFile (std::shared_ptr< FT > file, const G4String &fileName)
 
G4bool DeleteEmptyFile (const G4String &fileName)
 
void FileNotFoundWarning (const G4String &fileName, std::string_view functionName) const
 
G4TFileInformation< FT > * GetFileInfoInFunction (const G4String &fileName, std::string_view functionName, G4bool warn=true) const
 
std::shared_ptr< FT > GetFileInFunction (const G4String &fileName, std::string_view functionName, G4bool warn=true) const
 
G4bool WriteTFile (std::shared_ptr< FT > file, const G4String &fileName)
 

Private Attributes

const G4AnalysisManagerStatefAMState
 
std::map< G4String, G4TFileInformation< FT > * > fFileMap
 

Detailed Description

template<typename FT>
class G4VTFileManager< FT >

Definition at line 42 of file G4VTFileManager.hh.

Constructor & Destructor Documentation

◆ G4VTFileManager()

template<typename FT >
G4VTFileManager< FT >::G4VTFileManager ( const G4AnalysisManagerState state)
inlineexplicit

Definition at line 46 of file G4VTFileManager.hh.

◆ ~G4VTFileManager()

template<typename FT >
virtual G4VTFileManager< FT >::~G4VTFileManager ( )
virtualdefault

Member Function Documentation

◆ AddFileName()

void G4BaseFileManager::AddFileName ( const G4String fileName)
inherited

Definition at line 44 of file G4BaseFileManager.cc.

45{
46 // G4cout << "registering " << fileName << " in manager of " << GetFileType() << G4endl;
47
48 // Do nothing in file name is already present
49 for ( const auto& name : fFileNames ) {
50 if ( name == fileName ) return;
51 }
52
53 fFileNames.push_back(fileName);
54}
std::vector< G4String > fFileNames
const char * name(G4int ptype)

References G4BaseFileManager::fFileNames, and G4InuclParticleNames::name().

◆ Clear()

template<typename FT >
void G4VTFileManager< FT >::Clear
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 140 of file G4VTFileManager.hh.

References G4TFileManager< FT >::ClearData().

◆ ClearData()

template<typename FT >
void G4TFileManager< FT >::ClearData ( )
inherited

◆ CloseFile() [1/2]

template<typename FT >
G4bool G4VTFileManager< FT >::CloseFile ( const G4String fileName)
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 95 of file G4VTFileManager.hh.

96{
97 return G4TFileManager<FT>::CloseTFile(fileName);
98}
G4bool CloseTFile(const G4String &fileName)

References G4TFileManager< FT >::CloseTFile().

◆ CloseFile() [2/2]

template<typename FT >
virtual G4bool G4VFileManager::CloseFile ( const G4String fileName)
virtual

Implements G4VFileManager.

◆ CloseFileImpl()

template<typename FT >
virtual G4bool G4TFileManager< FT >::CloseFileImpl ( std::shared_ptr< FT >  file)
protectedpure virtualinherited

◆ CloseFiles()

template<typename FT >
G4bool G4VTFileManager< FT >::CloseFiles
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 119 of file G4VTFileManager.hh.

120{
121 auto result = G4TFileManager<FT>::CloseFiles();
122
123 fIsOpenFile = false;
124 fFile.reset();
125
126 return result;
127}
G4bool CloseFiles()
std::shared_ptr< FT > fFile

References G4TFileManager< FT >::CloseFiles().

◆ CloseTFile() [1/2]

template<typename FT >
G4bool G4TFileManager< FT >::CloseTFile ( const G4String fileName)
inherited

◆ CloseTFile() [2/2]

template<typename FT >
G4bool G4TFileManager< FT >::CloseTFile ( std::shared_ptr< FT >  file,
const G4String fileName 
)
privateinherited

◆ CreateFile()

template<typename FT >
G4bool G4VTFileManager< FT >::CreateFile ( const G4String fileName)
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 79 of file G4VTFileManager.hh.

80{
81 return (G4TFileManager<FT>::CreateTFile(fileName) != nullptr);
82}

◆ CreateFileImpl()

template<typename FT >
virtual std::shared_ptr< FT > G4TFileManager< FT >::CreateFileImpl ( const G4String fileName)
protectedpure virtualinherited

◆ CreateTFile()

template<typename FT >
std::shared_ptr< FT > G4TFileManager< FT >::CreateTFile ( const G4String fileName)
inherited

◆ DeleteEmptyFile()

template<typename FT >
G4bool G4TFileManager< FT >::DeleteEmptyFile ( const G4String fileName)
privateinherited

◆ DeleteEmptyFiles()

template<typename FT >
G4bool G4VTFileManager< FT >::DeleteEmptyFiles
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 132 of file G4VTFileManager.hh.

133{
135}
G4bool DeleteEmptyFiles()

References G4TFileManager< FT >::DeleteEmptyFiles().

◆ FileNotFoundWarning()

template<typename FT >
void G4TFileManager< FT >::FileNotFoundWarning ( const G4String fileName,
std::string_view  functionName 
) const
privateinherited

◆ GetFile()

template<typename FT >
std::shared_ptr< FT > G4VTFileManager< FT >::GetFile
inline

Definition at line 148 of file G4VTFileManager.hh.

149{
150 return fFile;
151}

◆ GetFileInfoInFunction()

template<typename FT >
G4TFileInformation< FT > * G4TFileManager< FT >::GetFileInfoInFunction ( const G4String fileName,
std::string_view  functionName,
G4bool  warn = true 
) const
privateinherited

◆ GetFileInFunction()

template<typename FT >
std::shared_ptr< FT > G4TFileManager< FT >::GetFileInFunction ( const G4String fileName,
std::string_view  functionName,
G4bool  warn = true 
) const
privateinherited

◆ GetFileName()

G4String G4BaseFileManager::GetFileName ( ) const
inlineinherited

Definition at line 105 of file G4BaseFileManager.hh.

105 {
106 return fFileName;
107}

References G4BaseFileManager::fFileName.

◆ GetFileNames()

const std::vector< G4String > & G4BaseFileManager::GetFileNames ( ) const
inlineinherited

Definition at line 109 of file G4BaseFileManager.hh.

109 {
110 return fFileNames;
111}

References G4BaseFileManager::fFileNames.

Referenced by G4GenericFileManager::OpenFiles().

◆ GetFileType()

G4String G4BaseFileManager::GetFileType ( ) const
virtualinherited

◆ GetFullFileName()

G4String G4BaseFileManager::GetFullFileName ( const G4String baseFileName = "",
G4bool  isPerThread = true 
) const
inherited

Definition at line 63 of file G4BaseFileManager.cc.

65{
66 G4String fileName(baseFileName);
67 if ( fileName == "" ) fileName = fFileName;
68
69 // Take out file extension
70 auto name = G4Analysis::GetBaseName(fileName);
71
72 // Add thread Id to a file name if MT processing
73 if ( isPerThread && ! fState.GetIsMaster() ) {
74 std::ostringstream os;
76 name.append("_t");
77 name.append(os.str());
78 }
79
80 // Add (back if it was present or is defined) file extension
81 auto extension = G4Analysis::GetExtension(fileName, GetFileType());
82 if ( extension.size() ) {
83 name.append(".");
84 name.append(extension);
85 }
86
87 return name;
88}
virtual G4String GetFileType() const
G4String GetExtension(const G4String &fileName, const G4String &defaultExtension="")
G4String GetBaseName(const G4String &fileName)
G4int G4GetThreadId()
Definition: G4Threading.cc:122

References G4BaseFileManager::fFileName, G4Analysis::GetBaseName(), and G4InuclParticleNames::name().

Referenced by G4Hdf5FileManager::GetNtupleFileName(), G4RootFileManager::GetNtupleFileName(), G4XmlRFileManager::GetRFile(), G4Hdf5RFileManager::GetRFile(), G4RootRFileManager::GetRFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), G4XmlFileManager::OpenFile(), G4XmlRFileManager::OpenRFile(), G4Hdf5RFileManager::OpenRFile(), and G4RootRFileManager::OpenRFile().

◆ GetHistoDirectoryName()

G4String G4VFileManager::GetHistoDirectoryName ( ) const
inlineinherited

Definition at line 120 of file G4VFileManager.hh.

121{ return fHistoDirectoryName; }
G4String fHistoDirectoryName

References G4VFileManager::fHistoDirectoryName.

Referenced by G4GenericFileManager::CreateFileManager().

◆ GetHnFileManager()

template<typename HT >
std::shared_ptr< G4VTHnFileManager< HT > > G4VFileManager::GetHnFileManager ( ) const
inherited

◆ GetHnFileName()

G4String G4BaseFileManager::GetHnFileName ( const G4String hnType,
const G4String hnName 
) const
inherited

Definition at line 91 of file G4BaseFileManager.cc.

93{
94 return G4Analysis::GetHnFileName(fFileName, GetFileType(), hnType, hnName);
95}
G4String GetHnFileName(const G4String &fileName, const G4String &fileType, const G4String &hnType, const G4String &hnName)

References G4BaseFileManager::fFileName, G4BaseFileManager::GetFileType(), and G4Analysis::GetHnFileName().

◆ GetNtupleDirectoryName()

G4String G4VFileManager::GetNtupleDirectoryName ( ) const
inlineinherited

◆ GetNtupleFileName() [1/2]

G4String G4BaseFileManager::GetNtupleFileName ( const G4String ntupleName) const
inherited

Definition at line 98 of file G4BaseFileManager.cc.

99{
101}
G4String GetNtupleFileName(const G4String &fileName, const G4String &fileType, const G4String &ntupleName)

References G4BaseFileManager::fFileName, G4BaseFileManager::GetFileType(), and G4Analysis::GetNtupleFileName().

◆ GetNtupleFileName() [2/2]

G4String G4BaseFileManager::GetNtupleFileName ( G4int  ntupleFileNumber) const
inherited

◆ GetPlotFileName()

G4String G4BaseFileManager::GetPlotFileName ( ) const
inherited

Definition at line 110 of file G4BaseFileManager.cc.

111{
113}
G4String GetPlotFileName(const G4String &fileName)

References G4BaseFileManager::fFileName, and G4Analysis::GetPlotFileName().

◆ GetTFile()

template<typename FT >
std::shared_ptr< FT > G4TFileManager< FT >::GetTFile ( const G4String fileName,
G4bool  warn = true 
) const
inherited

◆ IsOpenFile()

G4bool G4VFileManager::IsOpenFile ( ) const
inlineinherited

Definition at line 117 of file G4VFileManager.hh.

118{ return fIsOpenFile; }

References G4VFileManager::fIsOpenFile.

◆ LockDirectoryNames()

void G4VFileManager::LockDirectoryNames ( )
inlineinherited

◆ Message()

void G4BaseFileManager::Message ( G4int  level,
const G4String action,
const G4String objectType,
const G4String objectName = "",
G4bool  success = true 
) const
inlineprotectedinherited

◆ OpenFile()

virtual G4bool G4VFileManager::OpenFile ( const G4String fileName)
pure virtualinherited

◆ OpenFiles()

template<typename FT >
G4bool G4TFileManager< FT >::OpenFiles ( )
inherited

◆ SetFileName()

G4bool G4VFileManager::SetFileName ( const G4String fileName)
finalvirtualinherited

Reimplemented from G4BaseFileManager.

Definition at line 45 of file G4VFileManager.cc.

46{
47 // Check extension
48 auto name = fileName;
49 auto extension = G4Analysis::GetExtension(fileName);
50 if ( extension.size() && GetFileType().size() && extension != GetFileType() ) {
51 // replace extension
52 name = G4Analysis::GetBaseName(fileName) + "." + GetFileType();
53 Warn(fileName + " file extension is not valid for " + GetFileType() + " output.\n" +
54 name + " will be used.", fkClass, "SetFileName");
55 }
56
58}
virtual G4bool SetFileName(const G4String &fileName)
static constexpr std::string_view fkClass
void Warn(const G4String &message, const std::string_view inClass, const std::string_view inFunction)

References G4VFileManager::fkClass, G4Analysis::GetBaseName(), G4Analysis::GetExtension(), G4BaseFileManager::GetFileType(), G4InuclParticleNames::name(), G4BaseFileManager::SetFileName(), and G4Analysis::Warn().

Referenced by G4GenericFileManager::OpenFile().

◆ SetHistoDirectoryName()

G4bool G4VFileManager::SetHistoDirectoryName ( const G4String dirName)
virtualinherited

Reimplemented in G4GenericFileManager, and G4CsvFileManager.

Definition at line 61 of file G4VFileManager.cc.

62{
63 if ( fLockDirectoryNames ) {
64 Warn("Cannot set Histo directory name as its value was already used.",
65 fkClass, "SetHistoDirectoryName");
66 return false;
67 }
68
69 fHistoDirectoryName = dirName;
70 return true;
71}

References G4VFileManager::fHistoDirectoryName, G4VFileManager::fkClass, G4VFileManager::fLockDirectoryNames, and G4Analysis::Warn().

Referenced by G4GenericFileManager::SetHistoDirectoryName(), and G4CsvFileManager::SetHistoDirectoryName().

◆ SetIsEmpty()

template<typename FT >
G4bool G4VTFileManager< FT >::SetIsEmpty ( const G4String fileName,
G4bool  isEmpty 
)
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 103 of file G4VTFileManager.hh.

104{
105 return G4TFileManager<FT>::SetIsEmpty(fileName, isEmpty);
106}
G4bool SetIsEmpty(const G4String &fileName, G4bool isEmpty)

References G4TFileManager< FT >::SetIsEmpty().

◆ SetNtupleDirectoryName()

G4bool G4VFileManager::SetNtupleDirectoryName ( const G4String dirName)
virtualinherited

Reimplemented in G4GenericFileManager, and G4CsvFileManager.

Definition at line 74 of file G4VFileManager.cc.

75{
76 if ( fLockDirectoryNames ) {
77 Warn("Cannot set Ntuple directory name as its value was already used.",
78 fkClass, "SetNtupleDirectoryName");
79 return false;
80 }
81
82 fNtupleDirectoryName = dirName;
83 return true;
84}

References G4VFileManager::fkClass, G4VFileManager::fLockDirectoryNames, G4VFileManager::fNtupleDirectoryName, and G4Analysis::Warn().

Referenced by G4GenericFileManager::SetNtupleDirectoryName(), and G4CsvFileManager::SetNtupleDirectoryName().

◆ UnlockDirectoryNames()

void G4VFileManager::UnlockDirectoryNames ( )
inlineinherited

Definition at line 114 of file G4VFileManager.hh.

115{ fLockDirectoryNames = false; }

References G4VFileManager::fLockDirectoryNames.

Referenced by G4GenericFileManager::Clear().

◆ WriteFile() [1/2]

template<typename FT >
G4bool G4VTFileManager< FT >::WriteFile ( const G4String fileName)
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 87 of file G4VTFileManager.hh.

88{
89 return G4TFileManager<FT>::WriteTFile(fileName);
90}
G4bool WriteTFile(const G4String &fileName)

References G4TFileManager< FT >::WriteTFile().

◆ WriteFile() [2/2]

template<typename FT >
virtual G4bool G4VFileManager::WriteFile ( const G4String fileName)
virtual

Implements G4VFileManager.

◆ WriteFileImpl()

template<typename FT >
virtual G4bool G4TFileManager< FT >::WriteFileImpl ( std::shared_ptr< FT >  file)
protectedpure virtualinherited

◆ WriteFiles()

template<typename FT >
G4bool G4VTFileManager< FT >::WriteFiles
inlinefinalvirtual

Implements G4VFileManager.

Definition at line 111 of file G4VTFileManager.hh.

112{
114}
G4bool WriteFiles()

References G4TFileManager< FT >::WriteFiles().

◆ WriteTFile() [1/2]

template<typename FT >
G4bool G4TFileManager< FT >::WriteTFile ( const G4String fileName)
inherited

◆ WriteTFile() [2/2]

template<typename FT >
G4bool G4TFileManager< FT >::WriteTFile ( std::shared_ptr< FT >  file,
const G4String fileName 
)
privateinherited

Field Documentation

◆ fAMState

template<typename FT >
const G4AnalysisManagerState& G4TFileManager< FT >::fAMState
privateinherited

Definition at line 87 of file G4TFileManager.hh.

◆ fFile

template<typename FT >
std::shared_ptr<FT> G4VTFileManager< FT >::fFile { nullptr }
protected

Definition at line 73 of file G4VTFileManager.hh.

◆ fFileMap

template<typename FT >
std::map<G4String, G4TFileInformation<FT>*> G4TFileManager< FT >::fFileMap
privateinherited

Definition at line 88 of file G4TFileManager.hh.

◆ fFileName

G4String G4BaseFileManager::fFileName
protectedinherited

◆ fFileNames

std::vector<G4String> G4BaseFileManager::fFileNames
protectedinherited

◆ fH1FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::h1d> > G4VFileManager::fH1FileManager { nullptr }
protectedinherited

◆ fH2FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::h2d> > G4VFileManager::fH2FileManager { nullptr }
protectedinherited

◆ fH3FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::h3d> > G4VFileManager::fH3FileManager { nullptr }
protectedinherited

◆ fHistoDirectoryName

G4String G4VFileManager::fHistoDirectoryName
protectedinherited

◆ fIsOpenFile

G4bool G4VFileManager::fIsOpenFile { false }
protectedinherited

◆ fkClass

constexpr std::string_view G4VFileManager::fkClass { "G4VFileManager" }
staticconstexprprotectedinherited

◆ fLockDirectoryNames

G4bool G4VFileManager::fLockDirectoryNames { false }
protectedinherited

◆ fNtupleDirectoryName

G4String G4VFileManager::fNtupleDirectoryName
protectedinherited

◆ fP1FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::p1d> > G4VFileManager::fP1FileManager { nullptr }
protectedinherited

◆ fP2FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::p2d> > G4VFileManager::fP2FileManager { nullptr }
protectedinherited

◆ fState

const G4AnalysisManagerState& G4BaseFileManager::fState
protectedinherited

The documentation for this class was generated from the following file: