G4VFileManager Class Reference

#include <G4VFileManager.hh>

Inheritance diagram for G4VFileManager:

Public Member Functions
	G4VFileManager (const G4AnalysisManagerState &state)
	G4VFileManager ()=delete
	~G4VFileManager () override=default
virtual G4bool	OpenFile (const G4String &fileName)=0
virtual G4bool	CreateFile (const G4String &fileName)=0
virtual G4bool	WriteFile (const G4String &fileName)=0
virtual G4bool	CloseFile (const G4String &fileName)=0
virtual G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)=0
virtual G4bool	OpenFiles ()=0
virtual G4bool	WriteFiles ()=0
virtual G4bool	CloseFiles ()=0
virtual G4bool	DeleteEmptyFiles ()=0
virtual void	Clear ()=0
G4bool	SetFileName (const G4String &fileName) final
virtual G4bool	SetHistoDirectoryName (const G4String &dirName)
virtual G4bool	SetNtupleDirectoryName (const G4String &dirName)
void	LockDirectoryNames ()
void	UnlockDirectoryNames ()
G4bool	IsOpenFile () const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
G4int	GetCycle () const
template<typename HT >
std::shared_ptr< G4VTHnFileManager< HT > >	GetHnFileManager () const
Public Member Functions inherited from G4BaseFileManager
	G4BaseFileManager (const G4AnalysisManagerState &state)
	G4BaseFileManager ()=delete
virtual	~G4BaseFileManager ()=default
virtual G4bool	SetFileName (const G4String &fileName)
virtual G4String	GetFileType () const
virtual G4bool	HasCycles () const
void	AddFileName (const G4String &fileName)
G4String	GetFileName () const
G4String	GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const
const std::vector< G4String > &	GetFileNames () const
G4String	GetHnFileName (const G4String &hnType, const G4String &hnName) const
G4String	GetHnFileName (const G4String &fileName, G4int cycle=0) const
G4String	GetNtupleFileName (const G4String &ntupleName, G4int cycle=0) const
G4String	GetNtupleFileName (G4int ntupleFileNumber, G4int cycle=0) const
G4String	GetPlotFileName () const

Protected Attributes
G4String	fHistoDirectoryName
G4String	fNtupleDirectoryName
G4bool	fIsOpenFile { false }
G4bool	fLockDirectoryNames { false }
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 }
std::shared_ptr< G4VTHnFileManager< tools::histo::p1d > >	fP1FileManager { nullptr }
std::shared_ptr< G4VTHnFileManager< tools::histo::p2d > >	fP2FileManager { nullptr }
Protected Attributes inherited from G4BaseFileManager
const G4AnalysisManagerState &	fState
G4String	fFileName
std::vector< G4String >	fFileNames

Static Protected Attributes
static constexpr std::string_view	fkClass { "G4VFileManager" }

Additional Inherited Members
Protected Member Functions inherited from G4BaseFileManager
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Detailed Description

Definition at line 51 of file G4VFileManager.hh.

Constructor & Destructor Documentation

G4VFileManager() [1/2]

G4VFileManager::G4VFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 36 of file G4VFileManager.cc.

  : G4BaseFileManager(state)
{}

G4VFileManager() [2/2]

G4VFileManager::G4VFileManager ( )

delete

Referenced by G4VTFileManager< std::ofstream >::CloseFile().

~G4VFileManager()

G4VFileManager::~G4VFileManager ( )

overridedefault

Member Function Documentation

Clear()

virtual void G4VFileManager::Clear ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

CloseFile()

virtual G4bool G4VFileManager::CloseFile ( const G4String &  fileName )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, G4VTFileManager< G4RootFile >, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

CloseFiles()

virtual G4bool G4VFileManager::CloseFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

CreateFile()

virtual G4bool G4VFileManager::CreateFile ( const G4String &  fileName )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

DeleteEmptyFiles()

virtual G4bool G4VFileManager::DeleteEmptyFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

GetCycle()

G4int G4VFileManager::GetCycle ( ) const

inline

Definition at line 128 of file G4VFileManager.hh.

{ return fState.GetCycle(); }

Referenced by G4GenericFileManager::OpenFiles().

GetHistoDirectoryName()

G4String G4VFileManager::GetHistoDirectoryName ( ) const

inline

Definition at line 122 of file G4VFileManager.hh.

{ return fHistoDirectoryName; }

GetHnFileManager()

template<typename HT >

std::shared_ptr< G4VTHnFileManager< HT > > G4VFileManager::GetHnFileManager

(

)

const

GetNtupleDirectoryName()

G4String G4VFileManager::GetNtupleDirectoryName ( ) const

inline

Definition at line 125 of file G4VFileManager.hh.

{ return fNtupleDirectoryName; }

IsOpenFile()

G4bool G4VFileManager::IsOpenFile ( ) const

inline

Definition at line 119 of file G4VFileManager.hh.

{ return fIsOpenFile; }

LockDirectoryNames()

void G4VFileManager::LockDirectoryNames ( )

inline

Definition at line 113 of file G4VFileManager.hh.

{ fLockDirectoryNames = true; }

Referenced by G4GenericFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), and G4RootFileManager::OpenFile().

OpenFile()

virtual G4bool G4VFileManager::OpenFile ( const G4String &  fileName )

pure virtual

Implemented in G4CsvFileManager, G4GenericFileManager, G4Hdf5FileManager, G4RootFileManager, and G4XmlFileManager.

OpenFiles()

virtual G4bool G4VFileManager::OpenFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

SetFileName()

G4bool G4VFileManager::SetFileName ( const G4String &  fileName )

finalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 45 of file G4VFileManager.cc.

{
  // Check extension
  auto name = fileName;
  auto extension = G4Analysis::GetExtension(fileName);
  if ((extension.size() != 0u) && (GetFileType().size() != 0u) && extension != GetFileType()) {
    // replace extension
    name = G4Analysis::GetBaseName(fileName) + "." + GetFileType();
    Warn(fileName + " file extension is not valid for " + GetFileType() + " output.\n" +
         name + " will be used.", fkClass, "SetFileName");
  }
 
  return G4BaseFileManager::SetFileName(name);
}

Referenced by G4GenericFileManager::OpenFile().

SetHistoDirectoryName()

G4bool G4VFileManager::SetHistoDirectoryName ( const G4String &  dirName )

virtual

Reimplemented in G4CsvFileManager, and G4GenericFileManager.

Definition at line 61 of file G4VFileManager.cc.

{
  if ( fLockDirectoryNames ) {
    Warn("Cannot set Histo directory name as its value was already used.",
         fkClass, "SetHistoDirectoryName");
    return false;
  }
 
  fHistoDirectoryName = dirName;
  return true;
}

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

SetIsEmpty()

virtual G4bool G4VFileManager::SetIsEmpty ( const G4String &  fileName, G4bool  isEmpty  )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

SetNtupleDirectoryName()

G4bool G4VFileManager::SetNtupleDirectoryName ( const G4String &  dirName )

virtual

Reimplemented in G4CsvFileManager, and G4GenericFileManager.

Definition at line 74 of file G4VFileManager.cc.

{
  if ( fLockDirectoryNames ) {
    Warn("Cannot set Ntuple directory name as its value was already used.",
         fkClass, "SetNtupleDirectoryName");
    return false;
  }
 
  fNtupleDirectoryName = dirName;
  return true;
}

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

UnlockDirectoryNames()

void G4VFileManager::UnlockDirectoryNames ( )

inline

Definition at line 116 of file G4VFileManager.hh.

{ fLockDirectoryNames = false; }

Referenced by G4GenericFileManager::Clear().

WriteFile()

virtual G4bool G4VFileManager::WriteFile ( const G4String &  fileName )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, G4VTFileManager< G4RootFile >, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

WriteFiles()

virtual G4bool G4VFileManager::WriteFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

Member Data Documentation

fH1FileManager

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

protected

Definition at line 104 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fH2FileManager

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

protected

Definition at line 105 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fH3FileManager

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

protected

Definition at line 106 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fHistoDirectoryName

G4String G4VFileManager::fHistoDirectoryName

protected

Definition at line 98 of file G4VFileManager.hh.

Referenced by G4Hdf5FileManager::CreateFileImpl(), G4RootFileManager::CreateFileImpl(), GetHistoDirectoryName(), and SetHistoDirectoryName().

fIsOpenFile

G4bool G4VFileManager::fIsOpenFile { false }

protected

Definition at line 100 of file G4VFileManager.hh.

Referenced by G4GenericFileManager::CloseFiles(), IsOpenFile(), G4CsvFileManager::OpenFile(), G4GenericFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), and G4XmlFileManager::OpenFile().

fkClass

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

staticconstexprprotected

Definition at line 95 of file G4VFileManager.hh.

Referenced by SetFileName(), SetHistoDirectoryName(), and SetNtupleDirectoryName().

fLockDirectoryNames

G4bool G4VFileManager::fLockDirectoryNames { false }

protected

Definition at line 101 of file G4VFileManager.hh.

Referenced by LockDirectoryNames(), SetHistoDirectoryName(), SetNtupleDirectoryName(), and UnlockDirectoryNames().

fNtupleDirectoryName

G4String G4VFileManager::fNtupleDirectoryName

protected

Definition at line 99 of file G4VFileManager.hh.

Referenced by G4Hdf5FileManager::CreateFileImpl(), G4RootFileManager::CreateFileImpl(), GetNtupleDirectoryName(), and SetNtupleDirectoryName().

fP1FileManager

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

protected

Definition at line 107 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fP2FileManager

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

protected

Definition at line 108 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

---

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

• G4VFileManager.hh
• G4VFileManager.cc