G4BaseFileManager Class Reference

#include <G4BaseFileManager.hh>

Inheritance diagram for G4BaseFileManager:

Public Member Functions
	G4BaseFileManager (const G4AnalysisManagerState &state)
	G4BaseFileManager ()=delete
virtual	~G4BaseFileManager ()=default
virtual void	SetCompressionLevel (G4int level)
virtual G4bool	SetFileName (const G4String &fileName)
virtual G4String	GetFileType () const
virtual G4bool	HasCycles () const
void	AddFileName (const G4String &fileName)
G4int	GetCompressionLevel () const
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 Member Functions
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
void	ClearData ()

Protected Attributes
const G4AnalysisManagerState &	fState
G4int	fCompressionLevel { 1 }
G4String	fFileName
std::vector< G4String >	fFileNames

Detailed Description

Definition at line 39 of file G4BaseFileManager.hh.

Constructor & Destructor Documentation

G4BaseFileManager() [1/2]

G4BaseFileManager::G4BaseFileManager ( const G4AnalysisManagerState & state )

explicit

Definition at line 35 of file G4BaseFileManager.cc.

  : fState(state)
{}

Referenced by G4VFileManager::G4VFileManager(), and G4VRFileManager::G4VRFileManager().

G4BaseFileManager() [2/2]

G4BaseFileManager::G4BaseFileManager ( )

delete

~G4BaseFileManager()

virtual G4BaseFileManager::~G4BaseFileManager ( )

virtualdefault

Member Function Documentation

AddFileName()

void G4BaseFileManager::AddFileName

(

const G4String &

fileName

)

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

ClearData()

void G4BaseFileManager::ClearData ( )

inlineprotected

Definition at line 151 of file G4BaseFileManager.hh.

                                         {
  fFileNames.clear();
}

Referenced by G4VTFileManager< FT >::Clear(), and G4GenericFileManager::DeleteEmptyFiles().

GetCompressionLevel()

G4int G4BaseFileManager::GetCompressionLevel ( ) const

inline

Definition at line 133 of file G4BaseFileManager.hh.

{ return fCompressionLevel; }

Referenced by G4RootFileManager::CreateFileImpl().

GetFileName()

G4String G4BaseFileManager::GetFileName ( ) const

inline

Definition at line 136 of file G4BaseFileManager.hh.

                                                     {
  return fFileName;
}

GetFileNames()

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

inline

Definition at line 140 of file G4BaseFileManager.hh.

                                                                        {
  return fFileNames;
}

Referenced by G4GenericFileManager::OpenFiles().

GetFileType()

G4String G4BaseFileManager::GetFileType ( ) const

virtual

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

Definition at line 57 of file G4BaseFileManager.cc.

{
  return fState.GetFileType();
}

Referenced by GetFullFileName(), GetHnFileName(), GetNtupleFileName(), GetNtupleFileName(), G4CsvFileManager::GetNtupleFileName(), and G4VFileManager::SetFileName().

GetFullFileName()

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

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() != 0u) {
    name.append(".");
    name.append(extension);
  }
 
  return name;
}

Referenced by G4Hdf5RFileManager::GetRFile(), G4RootRFileManager::GetRFile(), G4XmlRFileManager::GetRFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), G4XmlFileManager::OpenFile(), G4RootRFileManager::OpenRFile(), and G4XmlRFileManager::OpenRFile().

GetHnFileName() [1/2]

G4String G4BaseFileManager::GetHnFileName	(	const G4String &	fileName,
		G4int	cycle = 0 ) const

Definition at line 98 of file G4BaseFileManager.cc.

{
  // Do nothing if cycle is supported by the output type
  if (HasCycles()) return fileName;
 
  return G4Analysis::GetHnFileName(fileName, GetFileType(), cycle);
}

GetHnFileName() [2/2]

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

Definition at line 91 of file G4BaseFileManager.cc.

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

GetNtupleFileName() [1/2]

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

Definition at line 108 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);
}

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

GetNtupleFileName() [2/2]

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

Definition at line 118 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);
}

GetPlotFileName()

G4String G4BaseFileManager::GetPlotFileName

(

)

const

Definition at line 128 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetPlotFileName(fFileName);
}

HasCycles()

G4bool G4BaseFileManager::HasCycles ( ) const

inlinevirtual

Reimplemented in G4RootFileManager.

Definition at line 129 of file G4BaseFileManager.hh.

                                                 {
  return false;
}

Referenced by GetHnFileName(), GetNtupleFileName(), and GetNtupleFileName().

Message()

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

inlineprotected

Definition at line 144 of file G4BaseFileManager.hh.

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

Referenced by G4GenericFileManager::CloseFiles(), G4GenericFileManager::DeleteEmptyFiles(), G4GenericFileManager::OpenFile(), G4GenericFileManager::OpenFiles(), G4CsvRFileManager::OpenRFile(), G4RootRFileManager::OpenRFile(), G4XmlRFileManager::OpenRFile(), and G4GenericFileManager::WriteFiles().

SetCompressionLevel()

void G4BaseFileManager::SetCompressionLevel ( G4int level )

inlinevirtual

Reimplemented in G4GenericFileManager.

Definition at line 120 of file G4BaseFileManager.hh.

{ fCompressionLevel = level; }

Referenced by G4GenericFileManager::SetCompressionLevel().

SetFileName()

G4bool G4BaseFileManager::SetFileName ( const G4String & fileName )

inlinevirtual

Reimplemented in G4VFileManager.

Definition at line 123 of file G4BaseFileManager.hh.

                                                                     {
  // CHECK if still needed in this base class
  fFileName = fileName;
  return true;
}

Referenced by G4VFileManager::SetFileName().

Member Data Documentation

fCompressionLevel

G4int G4BaseFileManager::fCompressionLevel { 1 }

protected

Definition at line 115 of file G4BaseFileManager.hh.

{ 1 };

Referenced by GetCompressionLevel(), and SetCompressionLevel().

fFileName

G4String G4BaseFileManager::fFileName

protected

Definition at line 116 of file G4BaseFileManager.hh.

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

fFileNames

std::vector<G4String> G4BaseFileManager::fFileNames

protected

Definition at line 117 of file G4BaseFileManager.hh.

Referenced by AddFileName(), ClearData(), and GetFileNames().

fState

const G4AnalysisManagerState& G4BaseFileManager::fState

protected

Definition at line 114 of file G4BaseFileManager.hh.

Referenced by G4GenericFileManager::CreateNtupleFileManager(), G4BaseFileManager(), G4VFileManager::GetCycle(), GetFileType(), GetFullFileName(), Message(), and G4XmlFileManager::OpenFile().

---

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

• G4BaseFileManager.hh
• G4BaseFileManager.cc