G4CsvFileManager Class Reference

#include <G4CsvFileManager.hh>

Inheritance diagram for G4CsvFileManager:

Public Member Functions
	G4CsvFileManager (const G4AnalysisManagerState &state)
	G4CsvFileManager ()=delete
	~G4CsvFileManager () override=default
G4bool	OpenFile (const G4String &fileName) final
G4bool	SetHistoDirectoryName (const G4String &dirName) final
G4bool	SetNtupleDirectoryName (const G4String &dirName) final
G4String	GetFileType () const final
G4bool	NotifyNtupleFile (CsvNtupleDescription *ntupleDescription)
G4bool	CreateNtupleFile (CsvNtupleDescription *ntupleDescription)
G4bool	CloseNtupleFile (CsvNtupleDescription *ntupleDescription)
G4bool	IsHistoDirectory () const
G4bool	IsNtupleDirectory () const
G4String	GetNtupleFileName (const G4String &ntupleName, G4int cycle=0) const
G4String	GetNtupleFileName (G4int ntupleFileNumber, G4int cycle=0) const
Public Member Functions inherited from G4VTFileManager< std::ofstream >
	G4VTFileManager (const G4AnalysisManagerState &state)
	~G4VTFileManager () override=default
G4bool	CreateFile (const G4String &fileName) final
G4bool	WriteFile (const G4String &fileName) final
virtual G4bool	WriteFile (const G4String &fileName)=0
G4bool	CloseFile (const G4String &fileName) final
virtual G4bool	CloseFile (const G4String &fileName)=0
G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty) final
G4bool	OpenFiles () final
G4bool	WriteFiles () final
G4bool	CloseFiles () final
G4bool	DeleteEmptyFiles () final
void	Clear () final
std::shared_ptr< std::ofstream >	GetFile () const
Public Member Functions inherited from G4VFileManager
	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
Public Member Functions inherited from G4TFileManager< FT >
	G4TFileManager (const G4AnalysisManagerState &state)
	G4TFileManager ()=delete
virtual	~G4TFileManager ()
std::shared_ptr< FT >	CreateTFile (const G4String &fileName)
G4bool	WriteTFile (const G4String &fileName)
G4bool	CloseTFile (const G4String &fileName)
G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)
std::shared_ptr< FT >	GetTFile (const G4String &fileName, G4bool warn=true) const
G4bool	OpenFiles ()
G4bool	WriteFiles ()
G4bool	CloseFiles ()
G4bool	DeleteEmptyFiles ()
void	ClearData ()

Protected Member Functions
std::shared_ptr< std::ofstream >	CreateFileImpl (const G4String &fileName) final
G4bool	WriteFileImpl (std::shared_ptr< std::ofstream > file) final
G4bool	CloseFileImpl (std::shared_ptr< std::ofstream > file) final
Protected Member Functions inherited from G4BaseFileManager
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
Protected Member Functions inherited from G4TFileManager< FT >
virtual std::shared_ptr< FT >	CreateFileImpl (const G4String &fileName)=0
virtual G4bool	WriteFileImpl (std::shared_ptr< FT > file)=0
virtual G4bool	CloseFileImpl (std::shared_ptr< FT > file)=0

Additional Inherited Members
Protected Attributes inherited from G4VTFileManager< std::ofstream >
std::shared_ptr< std::ofstream >	fFile
Protected Attributes inherited from G4VFileManager
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 inherited from G4VFileManager
static constexpr std::string_view	fkClass { "G4VFileManager" }

Detailed Description

Definition at line 45 of file G4CsvFileManager.hh.

Constructor & Destructor Documentation

G4CsvFileManager() [1/2]

G4CsvFileManager::G4CsvFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 39 of file G4CsvFileManager.cc.

 : G4VTFileManager(state)
{
  // Create helpers defined in the base class
  fH1FileManager = std::make_shared<G4CsvHnFileManager<histo::h1d>>(this);
  fH2FileManager = std::make_shared<G4CsvHnFileManager<histo::h2d>>(this);
  fH3FileManager = std::make_shared<G4CsvHnFileManager<histo::h3d>>(this);
  fP1FileManager = std::make_shared<G4CsvHnFileManager<histo::p1d>>(this);
  fP2FileManager = std::make_shared<G4CsvHnFileManager<histo::p2d>>(this);
}

G4CsvFileManager() [2/2]

G4CsvFileManager::G4CsvFileManager ( )

delete

~G4CsvFileManager()

G4CsvFileManager::~G4CsvFileManager ( )

overridedefault

Member Function Documentation

CloseFileImpl()

G4bool G4CsvFileManager::CloseFileImpl ( std::shared_ptr< std::ofstream >  file )

finalprotected

Definition at line 100 of file G4CsvFileManager.cc.

{
  if ( ! file ) return false;
 
  // close file
  file->close();
 
  return true;
}

CloseNtupleFile()

G4bool G4CsvFileManager::CloseNtupleFile

(

CsvNtupleDescription *

ntupleDescription

)

Definition at line 192 of file G4CsvFileManager.cc.

{
  // Notifying not empty file is done in G4CsvNtupleFileManager::ActionAtWrite,
  // as here we increment the cycle number and GetNtupleFileName returns a file name
  // for the next cycle version.
 
  // Ntuple files are registered in file manager map.
  // they will be closed with CloseFiles() calls
 
  ntupleDescription->GetFile().reset();
 
  return true;
}

CreateFileImpl()

std::shared_ptr< std::ofstream > G4CsvFileManager::CreateFileImpl ( const G4String &  fileName )

finalprotectedvirtual

Implements G4TFileManager< FT >.

Definition at line 81 of file G4CsvFileManager.cc.

{
  std::shared_ptr<std::ofstream> file = std::make_shared<std::ofstream>(fileName);
  if ( file->fail() ) {
    Warn("Cannot create file " + fileName, fkClass, "CreateFileImpl");
    return nullptr;
  }
 
  return file;
}

CreateNtupleFile()

G4bool G4CsvFileManager::CreateNtupleFile

(

CsvNtupleDescription *

ntupleDescription

)

Definition at line 165 of file G4CsvFileManager.cc.

{
  // Get ntuple file name per object (if defined)
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
 
  // Update file name if it is already in use
  while ( GetTFile(ntupleFileName, false) != nullptr ) {
    // the file is already in use
    auto oldName = ntupleFileName;
    auto newName = GetBaseName(oldName) + "_bis." + GetExtension(oldName);
    ntupleDescription->SetFileName(newName);
 
    Warn("Ntuple filename " + oldName + " is already in use.\n" +
         "It will be replaced with : " + newName,
         fkClass, "CreateNtupleFile");
 
    ntupleFileName = GetNtupleFileName(ntupleDescription);
  }
 
  // Create new ntuple file
  ntupleDescription->SetFile(CreateTFile(ntupleFileName));
 
  return (ntupleDescription->GetFile() != nullptr);
}

GetFileType()

G4String G4CsvFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 62 of file G4CsvFileManager.hh.

{ return "csv"; }

GetNtupleFileName() [1/2]

G4String G4BaseFileManager::GetNtupleFileName	(	const G4String &	ntupleName,
		G4int	cycle = 0
	)		const

Definition at line 80 of file G4BaseFileManager.cc.

{
  // Do not pass cycle if supported by the output type
  auto cycleToPass = (HasCycles()) ? 0 : cycle;
 
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleName, cycleToPass);
}

GetNtupleFileName() [2/2]

G4String G4BaseFileManager::GetNtupleFileName	(	G4int	ntupleFileNumber,
		G4int	cycle = 0
	)		const

Definition at line 88 of file G4BaseFileManager.cc.

{
  // Do not pass cycle if supported by the output type
  auto cycleToPass = (HasCycles()) ? 0 : cycle;
 
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleFileNumber, cycleToPass);
}

IsHistoDirectory()

G4bool G4CsvFileManager::IsHistoDirectory ( ) const

inline

Definition at line 92 of file G4CsvFileManager.hh.

{ return fIsHistoDirectory; }

IsNtupleDirectory()

G4bool G4CsvFileManager::IsNtupleDirectory ( ) const

inline

Definition at line 95 of file G4CsvFileManager.hh.

{ return fIsNtupleDirectory; }

NotifyNtupleFile()

G4bool G4CsvFileManager::NotifyNtupleFile

(

CsvNtupleDescription *

ntupleDescription

)

Definition at line 156 of file G4CsvFileManager.cc.

{
  // Notify not empty file
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
 
  return SetIsEmpty(ntupleFileName, ! ntupleDescription->GetHasFill());
}

OpenFile()

G4bool G4CsvFileManager::OpenFile ( const G4String &  fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 115 of file G4CsvFileManager.cc.

{
  // Keep file name
  fFileName =  fileName;
 
  fIsOpenFile = true;
 
  return true;
}

SetHistoDirectoryName()

G4bool G4CsvFileManager::SetHistoDirectoryName ( const G4String &  dirName )

finalvirtual

Reimplemented from G4VFileManager.

Definition at line 126 of file G4CsvFileManager.cc.

{
  // A directory is taken into account only if it exists in file system
  if ( G4fs::is_directory(dirName.data()) ) {
     fIsHistoDirectory = G4VFileManager::SetHistoDirectoryName(dirName);
     return fIsHistoDirectory;
  }
 
  G4Analysis::Warn("Directory " + dirName + " does not exists.\n"
    "Histograms will be written in the current directory.",
    fkClass, "SetHistoDirectoryName");
  return false;
}

SetNtupleDirectoryName()

G4bool G4CsvFileManager::SetNtupleDirectoryName ( const G4String &  dirName )

finalvirtual

Reimplemented from G4VFileManager.

Definition at line 141 of file G4CsvFileManager.cc.

{
  // A directory is taken into account only if it exists in file system
  if ( G4fs::is_directory(dirName.data()) ) {
     fIsNtupleDirectory = G4VFileManager::SetNtupleDirectoryName(dirName);
     return fIsNtupleDirectory;
  }
 
  G4Analysis::Warn("Directory " + dirName + " does not exists.\n"
    "Ntuples will be written in the current directory.",
    fkClass, "SetNtupleDirectoryName");
  return false;
}

WriteFileImpl()

G4bool G4CsvFileManager::WriteFileImpl ( std::shared_ptr< std::ofstream >  file )

finalprotected

Definition at line 93 of file G4CsvFileManager.cc.

{
  // Nothing to be done here
  return true;
}

---

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

• G4CsvFileManager.hh
• G4CsvFileManager.cc