G4RootFileManager Class Reference

#include <G4RootFileManager.hh>

Inheritance diagram for G4RootFileManager:

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	CloseNtupleFile (RootNtupleDescription *ntupleDescription)
G4bool	CloseTFile (const G4String &fileName)
virtual G4bool	CreateFile (const G4String &fileName) final
std::shared_ptr< G4RootFile >	CreateNtupleFile (RootNtupleDescription *ntupleDescription, G4int mainNumber=-1)
std::shared_ptr< G4RootFile >	CreateTFile (const G4String &fileName)
virtual G4bool	DeleteEmptyFiles () final
	G4RootFileManager ()=delete
	G4RootFileManager (const G4AnalysisManagerState &state)
unsigned int	GetBasketEntries () const
unsigned int	GetBasketSize () const
std::shared_ptr< G4RootFile >	GetFile () const
G4String	GetFileName () const
const std::vector< G4String > &	GetFileNames () const
virtual G4String	GetFileType () const final
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
std::shared_ptr< G4RootFile >	GetNtupleFile (RootNtupleDescription *ntupleDescription, G4bool perThread=true, G4int mainNumber=-1) const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
G4String	GetPlotFileName () const
std::shared_ptr< G4RootFile >	GetTFile (const G4String &fileName, G4bool warn=true) const
G4bool	IsOpenFile () const
void	LockDirectoryNames ()
virtual G4bool	OpenFile (const G4String &fileName) final
G4bool	OpenFiles ()
void	SetBasketEntries (unsigned int basketEntries)
void	SetBasketSize (unsigned int basketSize)
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	WriteNtupleFile (RootNtupleDescription *ntupleDescription)
G4bool	WriteTFile (const G4String &fileName)
virtual	~G4RootFileManager ()=default

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

Protected Attributes
std::shared_ptr< G4RootFile >	fFile
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

Private Member Functions
G4bool	CloseTFile (std::shared_ptr< G4RootFile > file, const G4String &fileName)
tools::wroot::directory *	CreateDirectory (tools::wroot::file *rfile, const G4String &directoryName, const G4String &objectType) const
G4bool	DeleteEmptyFile (const G4String &fileName)
void	FileNotFoundWarning (const G4String &fileName, std::string_view functionName) const
G4TFileInformation< G4RootFile > *	GetFileInfoInFunction (const G4String &fileName, std::string_view functionName, G4bool warn=true) const
std::shared_ptr< G4RootFile >	GetFileInFunction (const G4String &fileName, std::string_view functionName, G4bool warn=true) const
G4String	GetNtupleFileName (RootNtupleDescription *ntupleDescription, G4bool perThread=true, G4int mainNumber=-1) const
G4bool	WriteTFile (std::shared_ptr< G4RootFile > file, const G4String &fileName)

Private Attributes
const G4AnalysisManagerState &	fAMState
unsigned int	fBasketEntries { G4Analysis::kDefaultBasketEntries }
unsigned int	fBasketSize { G4Analysis::kDefaultBasketSize }
std::map< G4String, G4TFileInformation< G4RootFile > * >	fFileMap

Static Private Attributes
static constexpr std::string_view	fkClass { "G4RootFileManager" }

Detailed Description

Definition at line 53 of file G4RootFileManager.hh.

Constructor & Destructor Documentation

G4RootFileManager() [1/2]

G4RootFileManager::G4RootFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 42 of file G4RootFileManager.cc.

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

References G4VFileManager::fH1FileManager, G4VFileManager::fH2FileManager, G4VFileManager::fH3FileManager, G4VFileManager::fP1FileManager, and G4VFileManager::fP2FileManager.

G4RootFileManager() [2/2]

G4RootFileManager::G4RootFileManager ( )

delete

~G4RootFileManager()

virtual G4RootFileManager::~G4RootFileManager ( )

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

void G4VTFileManager< G4RootFile >::Clear

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 65 of file G4VTFileManager.hh.

{
  G4TFileManager<FT>::ClearData();
  UnlockDirectoryNames();
}

ClearData()

void G4TFileManager< G4RootFile >::ClearData ( )

inherited

CloseFile() [1/2]

G4bool G4VTFileManager< G4RootFile >::CloseFile ( const G4String &  fileName )

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 56 of file G4VTFileManager.hh.

{
  return G4TFileManager<FT>::CloseTFile(fileName);
}

CloseFile() [2/2]

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

virtualinherited

Implements G4VFileManager.

CloseFileImpl()

G4bool G4RootFileManager::CloseFileImpl ( std::shared_ptr< G4RootFile >  file )

finalprotectedvirtual

Implements G4TFileManager< G4RootFile >.

Definition at line 160 of file G4RootFileManager.cc.

{
// New prototype: called by G4TFileManager base classe
 
  if ( ! file ) return false;
 
  // close file
  std::get<0>(*file)->close();
 
  return true;
}

References geant4_check_module_cycles::file.

CloseFiles()

G4bool G4VTFileManager< G4RootFile >::CloseFiles

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 61 of file G4VTFileManager.hh.

{
  auto result = G4TFileManager<FT>::CloseFiles();
 
  fIsOpenFile = false;
  fFile.reset();
 
  return result;
}

CloseNtupleFile()

G4bool G4RootFileManager::CloseNtupleFile

(

RootNtupleDescription *

ntupleDescription

)

Definition at line 235 of file G4RootFileManager.cc.

{
  auto result = true;
 
  if ( ntupleDescription->fFile ) {
    // Ntuple files are registered in file manager map.
    // they will be closed with CloseFiles() calls
    ntupleDescription->fFile.reset();
    // Notify not empty file
    auto ntupleFileName = GetNtupleFileName(ntupleDescription);
    result &= SetIsEmpty(ntupleFileName, ! ntupleDescription->fHasFill);
  }
 
  return result;
}

References G4TNtupleDescription< NT, FT >::fFile, G4TNtupleDescription< NT, FT >::fHasFill, GetNtupleFileName(), and G4VTFileManager< G4RootFile >::SetIsEmpty().

CloseTFile() [1/2]

G4bool G4TFileManager< G4RootFile >::CloseTFile ( const G4String &  fileName )

inherited

CloseTFile() [2/2]

G4bool G4TFileManager< G4RootFile >::CloseTFile ( std::shared_ptr< G4RootFile >  file, const G4String &  fileName  )

privateinherited

CreateDirectory()

tools::wroot::directory * G4RootFileManager::CreateDirectory ( tools::wroot::file *  rfile, const G4String &  directoryName, const G4String &  objectType  ) const

private

Definition at line 58 of file G4RootFileManager.cc.

{
  if ( ! rfile ) return nullptr;
 
  if ( directoryName == "" ) {
    // Do not create a new directory if its name is not set
    return &(rfile->dir());
  }
 
  Message(kVL4, "create", "directory for " + objectType, directoryName);
 
  auto directory = rfile->dir().mkdir(directoryName);
  if ( ! directory ) {
    Warn("Cannot create directory " + directoryName, fkClass, "CreateDirectory");
    return nullptr;
  }
  else {
    Message(kVL2, "create", "directory for " + objectType, directoryName);
  }
 
  return directory;
}

References fkClass, G4Analysis::kVL2, G4Analysis::kVL4, G4BaseFileManager::Message(), and G4Analysis::Warn().

Referenced by CreateFileImpl().

CreateFile()

G4bool G4VTFileManager< G4RootFile >::CreateFile ( const G4String &  fileName )

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 54 of file G4VTFileManager.hh.

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

CreateFileImpl()

std::shared_ptr< G4RootFile > G4RootFileManager::CreateFileImpl ( const G4String &  fileName )

finalprotectedvirtual

Implements G4TFileManager< G4RootFile >.

Definition at line 117 of file G4RootFileManager.cc.

{
  // create file
  std::shared_ptr<wroot::file> file = std::make_shared<wroot::file>(G4cout, fileName);
  file->add_ziper('Z',compress_buffer);
  file->set_compression(fState.GetCompressionLevel());
 
  if ( ! file->is_open() ) {
    Warn("Cannot create file " + fileName, fkClass, "CreateFileImpl");
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  // create histo directory
  tools::wroot::directory* hdirectory
    = CreateDirectory(file.get(), fHistoDirectoryName, "histograms");
  if ( ! hdirectory ) {
    // Warning is issued in CreateDirectory
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  // create ntuple directory
  tools::wroot::directory* ndirectory
    = CreateDirectory(file.get(), fNtupleDirectoryName, "ntuples");
  if ( ! ndirectory ) {
    // Warning is issued in CreateDirectory
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  return std::make_shared<G4RootFile>(file, hdirectory, ndirectory);
}

References CreateDirectory(), G4VFileManager::fHistoDirectoryName, geant4_check_module_cycles::file, fkClass, G4VFileManager::fNtupleDirectoryName, G4BaseFileManager::fState, G4cout, G4AnalysisManagerState::GetCompressionLevel(), and G4Analysis::Warn().

CreateNtupleFile()

std::shared_ptr< G4RootFile > G4RootFileManager::CreateNtupleFile	(	RootNtupleDescription *	ntupleDescription,
		G4int	mainNumber = -1
	)

Definition at line 203 of file G4RootFileManager.cc.

{
  // get ntuple file name per object
  auto perThread = true;
  auto ntupleFileName = GetNtupleFileName(ntupleDescription, perThread, mainNumber);
 
  auto file = GetTFile(ntupleFileName, false);
  if (! file) {
    file = CreateTFile(ntupleFileName);
  }
 
  // register file in ntuple description only if it is not main ntuple file
  // (main ntuple files are managed in main ntuple manager)
  if ( mainNumber == -1 ) {
    ntupleDescription->fFile = file;
  }
 
  return file;
}

References G4TFileManager< G4RootFile >::CreateTFile(), G4TNtupleDescription< NT, FT >::fFile, geant4_check_module_cycles::file, GetNtupleFileName(), and G4TFileManager< G4RootFile >::GetTFile().

CreateTFile()

std::shared_ptr< G4RootFile > G4TFileManager< G4RootFile >::CreateTFile ( const G4String &  fileName )

inherited

DeleteEmptyFile()

G4bool G4TFileManager< G4RootFile >::DeleteEmptyFile ( const G4String &  fileName )

privateinherited

DeleteEmptyFiles()

G4bool G4VTFileManager< G4RootFile >::DeleteEmptyFiles

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 62 of file G4VTFileManager.hh.

{
  return G4TFileManager<FT>::DeleteEmptyFiles();
}

FileNotFoundWarning()

void G4TFileManager< G4RootFile >::FileNotFoundWarning ( const G4String &  fileName, std::string_view  functionName  ) const

privateinherited

GetBasketEntries()

unsigned int G4RootFileManager::GetBasketEntries ( ) const

inline

Definition at line 126 of file G4RootFileManager.hh.

{ return fBasketEntries; }

References fBasketEntries.

GetBasketSize()

unsigned int G4RootFileManager::GetBasketSize ( ) const

inline

Definition at line 122 of file G4RootFileManager.hh.

{ return fBasketSize; }

References fBasketSize.

GetFile()

std::shared_ptr< G4RootFile > G4VTFileManager< G4RootFile >::GetFile

inlineinherited

Definition at line 68 of file G4VTFileManager.hh.

{
  return fFile;
}

GetFileInfoInFunction()

G4TFileInformation< G4RootFile > * G4TFileManager< G4RootFile >::GetFileInfoInFunction ( const G4String &  fileName, std::string_view  functionName, G4bool  warn = true  ) const

privateinherited

GetFileInFunction()

std::shared_ptr< G4RootFile > G4TFileManager< G4RootFile >::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.

                                                     {
  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()

virtual G4String G4RootFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 67 of file G4RootFileManager.hh.

{ return "root"; }

Referenced by GetNtupleFileName().

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(), GetNtupleFileName(), G4XmlRFileManager::GetRFile(), G4Hdf5RFileManager::GetRFile(), G4RootRFileManager::GetRFile(), G4Hdf5FileManager::OpenFile(), OpenFile(), G4XmlFileManager::OpenFile(), G4XmlRFileManager::OpenRFile(), G4Hdf5RFileManager::OpenRFile(), and G4RootRFileManager::OpenRFile().

GetHistoDirectoryName()

G4String G4VFileManager::GetHistoDirectoryName ( ) const

inlineinherited

Definition at line 120 of file G4VFileManager.hh.

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

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

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

GetNtupleDirectoryName()

G4String G4VFileManager::GetNtupleDirectoryName ( ) const

inlineinherited

Definition at line 123 of file G4VFileManager.hh.

{ return fNtupleDirectoryName; }

References G4VFileManager::fNtupleDirectoryName.

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

GetNtupleFile()

std::shared_ptr< G4RootFile > G4RootFileManager::GetNtupleFile	(	RootNtupleDescription *	ntupleDescription,
		G4bool	perThread = true,
		G4int	mainNumber = -1
	)		const

Definition at line 225 of file G4RootFileManager.cc.

{
  // get ntuple file name per object
  auto ntupleFileName = GetNtupleFileName(ntupleDescription, perThread, mainNumber);
 
  return GetTFile(ntupleFileName, false);
}

References GetNtupleFileName(), and G4TFileManager< G4RootFile >::GetTFile().

GetNtupleFileName() [1/3]

G4String G4BaseFileManager::GetNtupleFileName

(

const G4String &

ntupleName

)

const

Definition at line 71 of file G4BaseFileManager.cc.

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

GetNtupleFileName() [2/3]

G4String G4BaseFileManager::GetNtupleFileName

(

G4int

ntupleFileNumber

)

const

Definition at line 77 of file G4BaseFileManager.cc.

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

GetNtupleFileName() [3/3]

G4String G4RootFileManager::GetNtupleFileName ( RootNtupleDescription *  ntupleDescription, G4bool  perThread = true, G4int  mainNumber = -1  ) const

private

Definition at line 84 of file G4RootFileManager.cc.

{
  // get ntuple file name
 
  auto ntupleFileName = ntupleDescription->fFileName;
  if ( ntupleFileName.size() ) {
    if ( perThread ) {
      ntupleFileName = GetTnFileName(ntupleFileName, GetFileType());
    }
  } else {
    // get default file name
    ntupleFileName = GetFullFileName(fFileName, perThread);
  }
 
  // update filename per mainNumber
  if ( mainNumber > -1 ) {
    // update filename per mainNumber
    ntupleFileName
      = G4Analysis::GetNtupleFileName(ntupleFileName, GetFileType(), mainNumber);
  }
 
  return ntupleFileName;
}

References G4BaseFileManager::fFileName, G4TNtupleDescription< NT, FT >::fFileName, GetFileType(), G4BaseFileManager::GetFullFileName(), G4Analysis::GetNtupleFileName(), and G4Analysis::GetTnFileName().

Referenced by CloseNtupleFile(), CreateNtupleFile(), and GetNtupleFile().

GetPlotFileName()

G4String G4BaseFileManager::GetPlotFileName ( ) const

inherited

Definition at line 110 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetPlotFileName(fFileName);
}

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

GetTFile()

std::shared_ptr< G4RootFile > G4TFileManager< G4RootFile >::GetTFile ( const G4String &  fileName, G4bool  warn = true  ) const

inherited

IsOpenFile()

G4bool G4VFileManager::IsOpenFile ( ) const

inlineinherited

Definition at line 117 of file G4VFileManager.hh.

{ return fIsOpenFile; }

References G4VFileManager::fIsOpenFile.

LockDirectoryNames()

void G4VFileManager::LockDirectoryNames ( )

inlineinherited

Definition at line 111 of file G4VFileManager.hh.

{ fLockDirectoryNames = true; }

References G4VFileManager::fLockDirectoryNames.

Referenced by G4GenericFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), and 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(), 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()

G4bool G4RootFileManager::OpenFile ( const G4String &  fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 176 of file G4RootFileManager.cc.

{
// Open default file
 
  // Keep file name
  fFileName =  fileName;
  auto name = GetFullFileName();
 
  if ( fFile ) {
    Warn("File " + fileName + " already exists.", fkClass, "OpenFile");
    fFile.reset();
  }
 
  // Create file (and save in in the file map)
  fFile = CreateTFile(name);
  if ( ! fFile ) {
    Warn("Failed to create file " + fileName, fkClass, "OpenFile");
    return false;
  }
 
  LockDirectoryNames();
  fIsOpenFile = true;
 
  return true;
}

References G4TFileManager< G4RootFile >::CreateTFile(), G4VTFileManager< G4RootFile >::fFile, G4BaseFileManager::fFileName, G4VFileManager::fIsOpenFile, fkClass, G4BaseFileManager::GetFullFileName(), G4VFileManager::LockDirectoryNames(), G4InuclParticleNames::name(), and G4Analysis::Warn().

OpenFiles()

G4bool G4TFileManager< G4RootFile >::OpenFiles ( )

inherited

SetBasketEntries()

void G4RootFileManager::SetBasketEntries ( unsigned int  basketEntries )

inline

Definition at line 118 of file G4RootFileManager.hh.

{ fBasketEntries = basketEntries; }

References fBasketEntries.

SetBasketSize()

void G4RootFileManager::SetBasketSize ( unsigned int  basketSize )

inline

Definition at line 114 of file G4RootFileManager.hh.

{ fBasketSize = basketSize; }

References fBasketSize.

SetFileName()

G4bool G4VFileManager::SetFileName ( const G4String &  fileName )

finalvirtualinherited

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

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

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

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

SetIsEmpty()

G4bool G4VTFileManager< G4RootFile >::SetIsEmpty ( const G4String &  fileName, G4bool  isEmpty  )

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 57 of file G4VTFileManager.hh.

{
  return G4TFileManager<FT>::SetIsEmpty(fileName, isEmpty);
}

SetNtupleDirectoryName()

G4bool G4VFileManager::SetNtupleDirectoryName ( const G4String &  dirName )

virtualinherited

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

{ fLockDirectoryNames = false; }

References G4VFileManager::fLockDirectoryNames.

Referenced by G4GenericFileManager::Clear().

WriteFile() [1/2]

G4bool G4VTFileManager< G4RootFile >::WriteFile ( const G4String &  fileName )

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 55 of file G4VTFileManager.hh.

{
  return G4TFileManager<FT>::WriteTFile(fileName);
}

WriteFile() [2/2]

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

virtualinherited

Implements G4VFileManager.

WriteFileImpl()

G4bool G4RootFileManager::WriteFileImpl ( std::shared_ptr< G4RootFile >  file )

finalprotectedvirtual

Implements G4TFileManager< G4RootFile >.

Definition at line 149 of file G4RootFileManager.cc.

{
// New prototype: called by G4TFileManager base classe
 
  if ( ! file ) return false;
 
  unsigned int n;
  return std::get<0>(*file)->write(n);
}

References geant4_check_module_cycles::file, and CLHEP::detail::n.

WriteFiles()

G4bool G4VTFileManager< G4RootFile >::WriteFiles

inlinefinalvirtualinherited

Implements G4VFileManager.

Definition at line 60 of file G4VTFileManager.hh.

{
  return G4TFileManager<FT>::WriteFiles();
}

WriteNtupleFile()

G4bool G4RootFileManager::WriteNtupleFile

(

RootNtupleDescription *

ntupleDescription

)

WriteTFile() [1/2]

G4bool G4TFileManager< G4RootFile >::WriteTFile ( const G4String &  fileName )

inherited

WriteTFile() [2/2]

G4bool G4TFileManager< G4RootFile >::WriteTFile ( std::shared_ptr< G4RootFile >  file, const G4String &  fileName  )

privateinherited

Field Documentation

fAMState

const G4AnalysisManagerState& G4TFileManager< G4RootFile >::fAMState

privateinherited

Definition at line 87 of file G4TFileManager.hh.

fBasketEntries

unsigned int G4RootFileManager::fBasketEntries { G4Analysis::kDefaultBasketEntries }

private

Definition at line 108 of file G4RootFileManager.hh.

Referenced by GetBasketEntries(), and SetBasketEntries().

fBasketSize

unsigned int G4RootFileManager::fBasketSize { G4Analysis::kDefaultBasketSize }

private

Definition at line 107 of file G4RootFileManager.hh.

Referenced by GetBasketSize(), and SetBasketSize().

fFile

std::shared_ptr<G4RootFile > G4VTFileManager< G4RootFile >::fFile

protectedinherited

Definition at line 73 of file G4VTFileManager.hh.

fFileMap

std::map<G4String, G4TFileInformation<G4RootFile >*> G4TFileManager< G4RootFile >::fFileMap

privateinherited

Definition at line 88 of file G4TFileManager.hh.

fFileName

G4String G4BaseFileManager::fFileName

protectedinherited

Definition at line 95 of file G4BaseFileManager.hh.

Referenced by G4BaseFileManager::GetFileName(), G4BaseFileManager::GetFullFileName(), G4BaseFileManager::GetHnFileName(), G4BaseFileManager::GetNtupleFileName(), GetNtupleFileName(), G4BaseFileManager::GetPlotFileName(), G4CsvFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), 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 }

protectedinherited

Definition at line 102 of file G4VFileManager.hh.

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

fH2FileManager

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

protectedinherited

Definition at line 103 of file G4VFileManager.hh.

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

fH3FileManager

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

protectedinherited

Definition at line 104 of file G4VFileManager.hh.

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

fHistoDirectoryName

G4String G4VFileManager::fHistoDirectoryName

protectedinherited

Definition at line 96 of file G4VFileManager.hh.

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

fIsOpenFile

G4bool G4VFileManager::fIsOpenFile { false }

protectedinherited

Definition at line 98 of file G4VFileManager.hh.

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

fkClass

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

staticconstexprprivate

Definition at line 104 of file G4RootFileManager.hh.

Referenced by CreateDirectory(), CreateFileImpl(), and OpenFile().

fLockDirectoryNames

G4bool G4VFileManager::fLockDirectoryNames { false }

protectedinherited

Definition at line 99 of file G4VFileManager.hh.

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

fNtupleDirectoryName

G4String G4VFileManager::fNtupleDirectoryName

protectedinherited

Definition at line 97 of file G4VFileManager.hh.

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

fP1FileManager

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

protectedinherited

Definition at line 105 of file G4VFileManager.hh.

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

fP2FileManager

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

protectedinherited

Definition at line 106 of file G4VFileManager.hh.

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

fState

const G4AnalysisManagerState& G4BaseFileManager::fState

protectedinherited

Definition at line 94 of file G4BaseFileManager.hh.

Referenced by 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/root/include/G4RootFileManager.hh
• source/analysis/root/src/G4RootFileManager.cc