G4CsvFileManager Class Reference

#include <G4CsvFileManager.hh>

Inheritance diagram for G4CsvFileManager:

Collaboration diagram for G4CsvFileManager:

Public Types
using	NtupleType = tools::wcsv::ntuple
using	NtupleDescriptionType = G4TNtupleDescription< NtupleType >

Public Member Functions
	G4CsvFileManager (const G4AnalysisManagerState &state)
	~G4CsvFileManager ()
virtual G4bool	OpenFile (const G4String &fileName) final
virtual G4bool	WriteFile () final
virtual G4bool	CloseFile () final
G4bool	CreateNtupleFile (NtupleDescriptionType *ntupleDescription)
G4bool	CloseNtupleFile (NtupleDescriptionType *ntupleDescription)
Public Member Functions inherited from G4VFileManager
	G4VFileManager (const G4AnalysisManagerState &state)
virtual	~G4VFileManager ()
virtual G4bool	SetFileName (const G4String &fileName) final
void	LockHistoDirectoryName ()
void	LockNtupleDirectoryName ()
G4bool	SetHistoDirectoryName (const G4String &dirName)
G4bool	SetNtupleDirectoryName (const G4String &dirName)
G4bool	IsOpenFile () const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
Public Member Functions inherited from G4BaseFileManager
	G4BaseFileManager (const G4AnalysisManagerState &state)
virtual	~G4BaseFileManager ()
G4String	GetFileName () const
G4String	GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const
G4String	GetHnFileName (const G4String &hnType, const G4String &hnName) const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
G4String	GetPlotFileName () const
G4String	GetFileType () const

Additional Inherited Members
Protected Member Functions inherited from G4BaseFileManager
G4String	TakeOffExtension (G4String &name) const
Protected Attributes inherited from G4VFileManager
G4bool	fIsOpenFile
G4String	fHistoDirectoryName
G4String	fNtupleDirectoryName
G4bool	fLockFileName
G4bool	fLockHistoDirectoryName
G4bool	fLockNtupleDirectoryName
Protected Attributes inherited from G4BaseFileManager
const G4AnalysisManagerState &	fState
G4String	fFileName

Detailed Description

Definition at line 41 of file G4CsvFileManager.hh.

Member Typedef Documentation

using G4CsvFileManager::NtupleDescriptionType = G4TNtupleDescription<NtupleType>

Definition at line 49 of file G4CsvFileManager.hh.

using G4CsvFileManager::NtupleType = tools::wcsv::ntuple

Definition at line 48 of file G4CsvFileManager.hh.

Constructor & Destructor Documentation

G4CsvFileManager::G4CsvFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 34 of file G4CsvFileManager.cc.

 : G4VFileManager(state)
{}

G4CsvFileManager::~G4CsvFileManager

(

)

Definition at line 39 of file G4CsvFileManager.cc.

{}

Member Function Documentation

G4bool G4CsvFileManager::CloseFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 67 of file G4CsvFileManager.cc.

{
  fLockFileName = false;
  fIsOpenFile = false;
  return true; 
} 

G4bool G4CsvFileManager::CloseNtupleFile

(

NtupleDescriptionType *

ntupleDescription

)

Definition at line 107 of file G4CsvFileManager.cc.

{
  G4String ntupleName = ntupleDescription->fNtupleBooking.name();

#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()
      ->Message("close", "file", GetNtupleFileName(ntupleName));
#endif

  // close file
  ntupleDescription->fFile->close(); 

#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()
      ->Message("close", "file", GetNtupleFileName(ntupleName));
#endif

  return true; 
} 

Here is the call graph for this function:

G4bool G4CsvFileManager::CreateNtupleFile

(

NtupleDescriptionType *

ntupleDescription

)

Definition at line 75 of file G4CsvFileManager.cc.

{
  G4String ntupleName = ntupleDescription->fNtupleBooking.name();

#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()
      ->Message("create", "file", GetNtupleFileName(ntupleName));
#endif

  auto ntupleFile = new std::ofstream(GetNtupleFileName(ntupleName));
  if ( ntupleFile->fail() ) {
    G4ExceptionDescription description;
    description << "      " << "Cannot open file " 
                << GetNtupleFileName(ntupleName);
    G4Exception("G4CsvFileManager::CreateNtupleFile()",
                "Analysis_W001", JustWarning, description);
    return false;
  }
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()
      ->Message("create", "file", GetNtupleFileName(ntupleName));
#endif

  ntupleDescription->fFile = ntupleFile;
  return true;
}  

Here is the call graph for this function:

G4bool G4CsvFileManager::OpenFile ( const G4String &  fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 47 of file G4CsvFileManager.cc.

{
  // Keep file name
  fFileName =  fileName;

  fLockFileName = true;
  fLockNtupleDirectoryName = true;
  fIsOpenFile = true;
  
  return true;
}  

G4bool G4CsvFileManager::WriteFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 60 of file G4CsvFileManager.cc.

{
  // nothing to be done for Csv file
  return true;
}

---

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

• geant4.10.03.p01/source/analysis/csv/include/G4CsvFileManager.hh
• geant4.10.03.p01/source/analysis/csv/src/G4CsvFileManager.cc