G4VRFileManager Class Reference

#include <G4VRFileManager.hh>

Inheritance diagram for G4VRFileManager:

Public Member Functions
void	AddFileName (const G4String &fileName)
virtual void	CloseFiles ()=0
	G4VRFileManager ()=delete
	G4VRFileManager (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	GetHnFileName (const G4String &hnType, const G4String &hnName) const
template<typename HT >
std::shared_ptr< G4VTHnRFileManager< HT > >	GetHnRFileManager () const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
G4String	GetPlotFileName () const
virtual G4bool	SetFileName (const G4String &fileName)
virtual	~G4VRFileManager ()=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< G4VTHnRFileManager< tools::histo::h1d > >	fH1RFileManager { nullptr }
std::shared_ptr< G4VTHnRFileManager< tools::histo::h2d > >	fH2RFileManager { nullptr }
std::shared_ptr< G4VTHnRFileManager< tools::histo::h3d > >	fH3RFileManager { nullptr }
std::shared_ptr< G4VTHnRFileManager< tools::histo::p1d > >	fP1RFileManager { nullptr }
std::shared_ptr< G4VTHnRFileManager< tools::histo::p2d > >	fP2RFileManager { nullptr }
const G4AnalysisManagerState &	fState

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

Detailed Description

Definition at line 50 of file G4VRFileManager.hh.

Constructor & Destructor Documentation

G4VRFileManager() [1/2]

G4VRFileManager::G4VRFileManager ( const G4AnalysisManagerState &  state )

inlineexplicit

Definition at line 53 of file G4VRFileManager.hh.

      : G4BaseFileManager(state) {}

G4VRFileManager() [2/2]

G4VRFileManager::G4VRFileManager ( )

delete

~G4VRFileManager()

virtual G4VRFileManager::~G4VRFileManager ( )

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

CloseFiles()

virtual void G4VRFileManager::CloseFiles ( )

pure virtual

Implemented in G4CsvRFileManager, G4Hdf5RFileManager, G4RootRFileManager, and G4XmlRFileManager.

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 G4VFileManager::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().

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

GetHnRFileManager()

template<typename HT >

std::shared_ptr< G4VTHnRFileManager< HT > > G4VRFileManager::GetHnRFileManager

(

)

const

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

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

SetFileName()

G4bool G4BaseFileManager::SetFileName ( const G4String &  fileName )

inlinevirtualinherited

Reimplemented in G4VFileManager.

Definition at line 99 of file G4BaseFileManager.hh.

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

References G4BaseFileManager::fFileName.

Referenced by G4VFileManager::SetFileName().

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

fH1RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::h1d> > G4VRFileManager::fH1RFileManager { nullptr }

protected

Definition at line 71 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager::G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

fH2RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::h2d> > G4VRFileManager::fH2RFileManager { nullptr }

protected

Definition at line 72 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager::G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

fH3RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::h3d> > G4VRFileManager::fH3RFileManager { nullptr }

protected

Definition at line 73 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager::G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

fkClass

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

staticconstexprprotected

Definition at line 67 of file G4VRFileManager.hh.

fP1RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::p1d> > G4VRFileManager::fP1RFileManager { nullptr }

protected

Definition at line 74 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager::G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

fP2RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::p2d> > G4VRFileManager::fP2RFileManager { nullptr }

protected

Definition at line 75 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager::G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

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 file:

• source/analysis/management/include/G4VRFileManager.hh