#include <G4VFileManager.hh>

Inheritance diagram for G4VFileManager:

Public Member Functions
void	AddFileName (const G4String &fileName)

virtual void	Clear ()=0

virtual G4bool	CloseFile (const G4String &fileName)=0

virtual G4bool	CloseFiles ()=0

virtual G4bool	CreateFile (const G4String &fileName)=0

virtual G4bool	DeleteEmptyFiles ()=0

	G4VFileManager ()=delete

	G4VFileManager (const G4AnalysisManagerState &state)

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

G4bool	IsOpenFile () const

void	LockDirectoryNames ()

virtual G4bool	OpenFile (const G4String &fileName)=0

virtual G4bool	SetFileName (const G4String &fileName) final

virtual G4bool	SetHistoDirectoryName (const G4String &dirName)

virtual G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)=0

virtual G4bool	SetNtupleDirectoryName (const G4String &dirName)

void	UnlockDirectoryNames ()

virtual G4bool	WriteFile (const G4String &fileName)=0

virtual G4bool	WriteFiles ()=0

virtual	~G4VFileManager ()=default

Protected Member Functions
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Protected Attributes
G4String	fFileName

std::vector< G4String >	fFileNames

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 G4AnalysisManagerState &	fState

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

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.

37 : G4BaseFileManager(state)

38{}

G4BaseFileManager::G4BaseFileManager

G4BaseFileManager()=delete

◆ G4VFileManager() [2/2]

G4VFileManager::G4VFileManager ( )

delete

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

◆ ~G4VFileManager()

virtual G4VFileManager::~G4VFileManager ( )

virtualdefault

Member Function Documentation

◆ AddFileName()

void G4BaseFileManager::AddFileName ( const G4String & fileName )

inherited

Definition at line 44 of file G4BaseFileManager.cc.

{
  // G4cout << "registering " << fileName << " in manager of " << GetFileType() << G4endl;
 
  // Do nothing in file name is already present
  for ( const auto& name : fFileNames ) {
    if ( name == fileName ) return;
  }
 
  fFileNames.push_back(fileName);
}

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

◆ 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 >.

◆ GetFileName()

G4String G4BaseFileManager::GetFileName ( ) const

inlineinherited

Definition at line 105 of file G4BaseFileManager.hh.

                                                     {
  return fFileName;
}

References G4BaseFileManager::fFileName.

◆ GetFileNames()

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

inlineinherited

Definition at line 109 of file G4BaseFileManager.hh.

                                                                        {
  return fFileNames;
}

References G4BaseFileManager::fFileNames.

Referenced by G4GenericFileManager::OpenFiles().

◆ GetFileType()

G4String G4BaseFileManager::GetFileType ( ) const

virtualinherited

Reimplemented in G4CsvFileManager, G4CsvRFileManager, G4GenericFileManager, G4Hdf5FileManager, G4Hdf5RFileManager, G4RootFileManager, G4RootRFileManager, G4XmlFileManager, and G4XmlRFileManager.

Definition at line 57 of file G4BaseFileManager.cc.

{
  return G4StrUtil::to_lower_copy(fState.GetType());
}

References G4BaseFileManager::fState, G4AnalysisManagerState::GetType(), and G4StrUtil::to_lower_copy().

Referenced by G4BaseFileManager::GetHnFileName(), G4BaseFileManager::GetNtupleFileName(), and SetFileName().

◆ GetFullFileName()

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

inherited

Definition at line 63 of file G4BaseFileManager.cc.

{
  G4String fileName(baseFileName);
  if ( fileName == "" ) fileName = fFileName;
 
  // Take out file extension
  auto name = G4Analysis::GetBaseName(fileName);
 
  // Add thread Id to a file name if MT processing
  if ( isPerThread && ! fState.GetIsMaster() ) {
    std::ostringstream os;
    os << G4Threading::G4GetThreadId();
    name.append("_t");
    name.append(os.str());
  }
 
  // Add (back if it was present or is defined) file extension
  auto extension = G4Analysis::GetExtension(fileName, GetFileType());
  if ( extension.size() ) {
    name.append(".");
    name.append(extension);
  }
 
  return name;
}

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

inline

Definition at line 120 of file G4VFileManager.hh.

121{ return fHistoDirectoryName; }

G4VFileManager::fHistoDirectoryName

G4String fHistoDirectoryName

Definition: G4VFileManager.hh:96

References fHistoDirectoryName.

Referenced by G4GenericFileManager::CreateFileManager().

◆ GetHnFileManager()

template<typename HT >

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

◆ GetHnFileName()

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

inherited

Definition at line 91 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetHnFileName(fFileName, GetFileType(), hnType, hnName);
}

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

◆ GetNtupleDirectoryName()

G4String G4VFileManager::GetNtupleDirectoryName ( ) const

inline

Definition at line 123 of file G4VFileManager.hh.

124{ return fNtupleDirectoryName; }

G4VFileManager::fNtupleDirectoryName

G4String fNtupleDirectoryName

Definition: G4VFileManager.hh:97

References fNtupleDirectoryName.

Referenced by G4GenericFileManager::CreateFileManager(), and G4CsvFileManager::GetNtupleFileName().

◆ GetNtupleFileName() [1/2]

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

inherited

Definition at line 98 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleName);
}

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

◆ GetNtupleFileName() [2/2]

G4String G4BaseFileManager::GetNtupleFileName ( G4int ntupleFileNumber ) const

inherited

Definition at line 104 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleFileNumber);
}

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

◆ GetPlotFileName()

G4String G4BaseFileManager::GetPlotFileName ( ) const

inherited

Definition at line 110 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetPlotFileName(fFileName);
}

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

◆ IsOpenFile()

G4bool G4VFileManager::IsOpenFile ( ) const

inline

Definition at line 117 of file G4VFileManager.hh.

118{ return fIsOpenFile; }

G4VFileManager::fIsOpenFile

G4bool fIsOpenFile

Definition: G4VFileManager.hh:98

References fIsOpenFile.

◆ LockDirectoryNames()

void G4VFileManager::LockDirectoryNames ( )

inline

Definition at line 111 of file G4VFileManager.hh.

112{ fLockDirectoryNames = true; }

G4VFileManager::fLockDirectoryNames

G4bool fLockDirectoryNames

Definition: G4VFileManager.hh:99

References fLockDirectoryNames.

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

◆ Message()

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

inlineprotectedinherited

Definition at line 113 of file G4BaseFileManager.hh.

{
  fState.Message(level, action, objectType, objectName, success);
}

References geant4_check_module_cycles::action, G4BaseFileManager::fState, and G4AnalysisManagerState::Message().

Referenced by G4GenericFileManager::CloseFiles(), G4CsvFileManager::CloseNtupleFile(), G4XmlFileManager::CloseNtupleFile(), G4Hdf5FileManager::CreateDirectory(), G4RootFileManager::CreateDirectory(), G4GenericFileManager::CreateFileManager(), G4CsvFileManager::CreateNtupleFile(), G4XmlFileManager::CreateNtupleFile(), G4GenericFileManager::DeleteEmptyFiles(), G4Hdf5RFileManager::OpenDirectory(), G4GenericFileManager::OpenFile(), G4GenericFileManager::OpenFiles(), G4CsvRFileManager::OpenRFile(), G4XmlRFileManager::OpenRFile(), G4Hdf5RFileManager::OpenRFile(), G4RootRFileManager::OpenRFile(), and G4GenericFileManager::WriteFiles().

◆ OpenFile()

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

pure virtual

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

◆ 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() && GetFileType().size() && 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);
}

References 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 )

virtual

Reimplemented in G4GenericFileManager, and G4CsvFileManager.

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;
}

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

Referenced by G4GenericFileManager::SetHistoDirectoryName(), and G4CsvFileManager::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 G4GenericFileManager, and G4CsvFileManager.

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;
}

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

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

◆ UnlockDirectoryNames()

void G4VFileManager::UnlockDirectoryNames ( )

inline

Definition at line 114 of file G4VFileManager.hh.

115{ fLockDirectoryNames = false; }

References fLockDirectoryNames.

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 >.

Field Documentation

◆ fFileName

G4String G4BaseFileManager::fFileName

protectedinherited

Definition at line 95 of file G4BaseFileManager.hh.

Referenced by G4BaseFileManager::GetFileName(), G4BaseFileManager::GetFullFileName(), G4BaseFileManager::GetHnFileName(), G4BaseFileManager::GetNtupleFileName(), G4RootFileManager::GetNtupleFileName(), G4BaseFileManager::GetPlotFileName(), G4CsvFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), G4XmlFileManager::OpenFile(), and G4BaseFileManager::SetFileName().

◆ fFileNames

std::vector<G4String> G4BaseFileManager::fFileNames

protectedinherited

Definition at line 96 of file G4BaseFileManager.hh.

Referenced by G4BaseFileManager::AddFileName(), and G4BaseFileManager::GetFileNames().

◆ fH1FileManager

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

protected

Definition at line 102 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 103 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 104 of file G4VFileManager.hh.

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

◆ fHistoDirectoryName

G4String G4VFileManager::fHistoDirectoryName

protected

Definition at line 96 of file G4VFileManager.hh.

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

◆ fIsOpenFile

G4bool G4VFileManager::fIsOpenFile { false }

protected

Definition at line 98 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 93 of file G4VFileManager.hh.

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

◆ fLockDirectoryNames

G4bool G4VFileManager::fLockDirectoryNames { false }

protected

Definition at line 99 of file G4VFileManager.hh.

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

◆ fNtupleDirectoryName

G4String G4VFileManager::fNtupleDirectoryName

protected

Definition at line 97 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 105 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 106 of file G4VFileManager.hh.

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

◆ fState

const G4AnalysisManagerState& G4BaseFileManager::fState

protectedinherited

Definition at line 94 of file G4BaseFileManager.hh.

Referenced by G4RootFileManager::CreateFileImpl(), G4GenericFileManager::CreateFileManager(), G4GenericFileManager::CreateNtupleFileManager(), G4BaseFileManager::GetFileType(), G4BaseFileManager::Message(), and G4XmlFileManager::OpenFile().

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

source/analysis/management/include/G4VFileManager.hh
source/analysis/management/src/G4VFileManager.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4VFileManager() [1/2]

◆ G4VFileManager() [2/2]

◆ ~G4VFileManager()

Member Function Documentation

◆ AddFileName()

◆ Clear()

◆ CloseFile()

◆ CloseFiles()

◆ CreateFile()

◆ DeleteEmptyFiles()

◆ GetFileName()

◆ GetFileNames()

◆ GetFileType()

◆ GetFullFileName()

◆ GetHistoDirectoryName()

◆ GetHnFileManager()

◆ GetHnFileName()

◆ GetNtupleDirectoryName()

◆ GetNtupleFileName() [1/2]

◆ GetNtupleFileName() [2/2]

◆ GetPlotFileName()

◆ IsOpenFile()

◆ LockDirectoryNames()

◆ Message()

◆ OpenFile()

◆ SetFileName()

◆ SetHistoDirectoryName()

◆ SetIsEmpty()

◆ SetNtupleDirectoryName()

◆ UnlockDirectoryNames()

◆ WriteFile()

◆ WriteFiles()

Field Documentation

◆ fFileName

◆ fFileNames

◆ fH1FileManager

◆ fH2FileManager

◆ fH3FileManager

◆ fHistoDirectoryName

◆ fIsOpenFile

◆ fkClass

◆ fLockDirectoryNames

◆ fNtupleDirectoryName

◆ fP1FileManager

◆ fP2FileManager

◆ fState