G4XmlNtupleFileManager Class Reference

#include <G4XmlNtupleFileManager.hh>

Inheritance diagram for G4XmlNtupleFileManager:

Public Member Functions
virtual G4bool	ActionAtCloseFile (G4bool reset) override
virtual G4bool	ActionAtOpenFile (const G4String &fileName) override
virtual G4bool	ActionAtWrite () override
virtual std::shared_ptr< G4VNtupleManager >	CreateNtupleManager () override
	G4XmlNtupleFileManager ()=delete
	G4XmlNtupleFileManager (const G4AnalysisManagerState &state)
G4String	GetFileType () const
std::shared_ptr< G4XmlNtupleManager >	GetNtupleManager () const
virtual G4bool	IsNtupleMergingSupported () const
virtual G4bool	Reset () override
virtual void	SetBasketEntries (unsigned int basketEntries)
virtual void	SetBasketSize (unsigned int basketSize)
virtual void	SetBookingManager (std::shared_ptr< G4NtupleBookingManager > bookingManager)
void	SetFileManager (std::shared_ptr< G4XmlFileManager > fileManager)
virtual void	SetNtupleMerging (G4bool mergeNtuples, G4int nofReducedNtupleFiles=0)
virtual void	SetNtupleRowWise (G4bool rowWise, G4bool rowMode=true)
virtual	~G4XmlNtupleFileManager ()=default

Protected Member Functions
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Protected Attributes
std::shared_ptr< G4NtupleBookingManager >	fBookingManager { nullptr }
G4String	fFileType
const G4AnalysisManagerState &	fState

Private Member Functions
G4bool	CloseNtupleFiles ()

Private Attributes
std::shared_ptr< G4XmlFileManager >	fFileManager { nullptr }
std::shared_ptr< G4XmlNtupleManager >	fNtupleManager { nullptr }

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

Detailed Description

Definition at line 44 of file G4XmlNtupleFileManager.hh.

Constructor & Destructor Documentation

G4XmlNtupleFileManager() [1/2]

G4XmlNtupleFileManager::G4XmlNtupleFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 40 of file G4XmlNtupleFileManager.cc.

 : G4VNtupleFileManager(state, "csv")
{}

G4XmlNtupleFileManager() [2/2]

G4XmlNtupleFileManager::G4XmlNtupleFileManager ( )

delete

~G4XmlNtupleFileManager()

virtual G4XmlNtupleFileManager::~G4XmlNtupleFileManager ( )

virtualdefault

Member Function Documentation

ActionAtCloseFile()

G4bool G4XmlNtupleFileManager::ActionAtCloseFile ( G4bool  reset )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 99 of file G4XmlNtupleFileManager.cc.

{
  auto result = true;
 
  // Close ntuple files
  result &= CloseNtupleFiles();
 
  // Reset data
  if ( ! reset ) {
    result = Reset();
    if ( ! result ) {
      Warn("Resetting data failed", fkClass, "ActionAtCloseFile");
    }
  }
 
  return result;
}

References CloseNtupleFiles(), fkClass, Reset(), and G4Analysis::Warn().

ActionAtOpenFile()

G4bool G4XmlNtupleFileManager::ActionAtOpenFile ( const G4String &  fileName )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 76 of file G4XmlNtupleFileManager.cc.

{
  // Create ntuples if they are booked
  // (The files will be created with creating ntuples)
  fNtupleManager->CreateNtuplesFromBooking(
    fBookingManager->GetNtupleBookingVector());
 
  return true;
}

References G4VNtupleFileManager::fBookingManager, and fNtupleManager.

ActionAtWrite()

G4bool G4XmlNtupleFileManager::ActionAtWrite ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 87 of file G4XmlNtupleFileManager.cc.

{
  auto ntupleVector = fNtupleManager->GetNtupleDescriptionVector();
 
  for ( auto ntuple : ntupleVector ) {
    if ( ntuple->fNtuple ) ntuple->fNtuple->write_trailer();
  }
 
  return true;
}

References fNtupleManager.

CloseNtupleFiles()

G4bool G4XmlNtupleFileManager::CloseNtupleFiles ( )

private

Definition at line 49 of file G4XmlNtupleFileManager.cc.

{
 // Close ntuple files
 
  auto result = true;
  auto ntupleVector = fNtupleManager->GetNtupleDescriptionVector();
  for ( auto ntupleDescription : ntupleVector) {
    result &= fFileManager->CloseNtupleFile(ntupleDescription);
  }
 
  return result;
}

References fFileManager, and fNtupleManager.

Referenced by ActionAtCloseFile().

CreateNtupleManager()

std::shared_ptr< G4VNtupleManager > G4XmlNtupleFileManager::CreateNtupleManager ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 67 of file G4XmlNtupleFileManager.cc.

{
  fNtupleManager = std::make_shared<G4XmlNtupleManager>(fState);
  fNtupleManager->SetFileManager(fFileManager);
 
  return fNtupleManager;
}

References fFileManager, fNtupleManager, and G4VNtupleFileManager::fState.

GetFileType()

G4String G4VNtupleFileManager::GetFileType ( ) const

inlineinherited

Definition at line 107 of file G4VNtupleFileManager.hh.

                                                        {
  return fFileType;
}

References G4VNtupleFileManager::fFileType.

GetNtupleManager()

std::shared_ptr< G4XmlNtupleManager > G4XmlNtupleFileManager::GetNtupleManager ( ) const

inline

Definition at line 81 of file G4XmlNtupleFileManager.hh.

{ return fNtupleManager; }

References fNtupleManager.

IsNtupleMergingSupported()

G4bool G4VNtupleFileManager::IsNtupleMergingSupported ( ) const

inlinevirtualinherited

Reimplemented in G4RootNtupleFileManager.

Definition at line 103 of file G4VNtupleFileManager.hh.

                                                                   {
  return false;
}

Message()

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

inlineprotectedinherited

Definition at line 111 of file G4VNtupleFileManager.hh.

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

References geant4_check_module_cycles::action, G4VNtupleFileManager::fState, and G4AnalysisManagerState::Message().

Referenced by G4RootNtupleFileManager::ActionAtOpenFile(), G4RootNtupleFileManager::ActionAtWrite(), G4RootNtupleFileManager::CreateNtupleManager(), G4RootNtupleFileManager::SetNtupleMergingMode(), and G4RootNtupleFileManager::SetNtupleRowWise().

Reset()

G4bool G4XmlNtupleFileManager::Reset ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 118 of file G4XmlNtupleFileManager.cc.

{
// Reset histograms and ntuple
 
  return fNtupleManager->Reset();
}

References fNtupleManager.

Referenced by ActionAtCloseFile().

SetBasketEntries()

void G4VNtupleFileManager::SetBasketEntries ( unsigned int  basketEntries )

virtualinherited

Reimplemented in G4RootNtupleFileManager.

Definition at line 85 of file G4VNtupleFileManager.cc.

{
// The function is overridden in the managers which supports ntuple merging
// Here we give just a warning that the feature is not available.
 
  NtupleMergingWarning(fkClass, "SetBasketEntries", fFileType);
}

References G4VNtupleFileManager::fFileType, G4VNtupleFileManager::fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

SetBasketSize()

void G4VNtupleFileManager::SetBasketSize ( unsigned int  basketSize )

virtualinherited

Reimplemented in G4RootNtupleFileManager.

Definition at line 76 of file G4VNtupleFileManager.cc.

{
// The function is overridden in the managers which supports ntuple merging
// Here we give just a warning that the feature is not available.
 
  NtupleMergingWarning(fkClass, "SetBasketSize", fFileType);
}

References G4VNtupleFileManager::fFileType, G4VNtupleFileManager::fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

SetBookingManager()

void G4VNtupleFileManager::SetBookingManager ( std::shared_ptr< G4NtupleBookingManager >  bookingManager )

inlinevirtualinherited

Definition at line 99 of file G4VNtupleFileManager.hh.

{ fBookingManager = bookingManager; }

References G4VNtupleFileManager::fBookingManager.

SetFileManager()

void G4XmlNtupleFileManager::SetFileManager ( std::shared_ptr< G4XmlFileManager >  fileManager )

inline

Definition at line 77 of file G4XmlNtupleFileManager.hh.

{ fFileManager = fileManager; }

References fFileManager.

SetNtupleMerging()

void G4VNtupleFileManager::SetNtupleMerging ( G4bool  mergeNtuples, G4int  nofReducedNtupleFiles = 0  )

virtualinherited

---

Reimplemented in G4RootNtupleFileManager.

Definition at line 56 of file G4VNtupleFileManager.cc.

{
// The function is overridden in the managers which supports ntuple merging
// Here we give just a warning that the feature is not available.
 
  NtupleMergingWarning(fkClass, "SetNtupleMerging", fFileType);
}

References G4VNtupleFileManager::fFileType, G4VNtupleFileManager::fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

SetNtupleRowWise()

void G4VNtupleFileManager::SetNtupleRowWise ( G4bool  rowWise, G4bool  rowMode = true  )

virtualinherited

Reimplemented in G4RootNtupleFileManager.

Definition at line 66 of file G4VNtupleFileManager.cc.

{
// The function is overridden in the managers which supports ntuple merging
// Here we give just a warning that the feature is not available.
 
  NtupleMergingWarning(fkClass, "SetNtupleRowWise", fFileType);
}

References G4VNtupleFileManager::fFileType, G4VNtupleFileManager::fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

Field Documentation

fBookingManager

std::shared_ptr<G4NtupleBookingManager> G4VNtupleFileManager::fBookingManager { nullptr }

protectedinherited

Definition at line 90 of file G4VNtupleFileManager.hh.

Referenced by G4CsvNtupleFileManager::ActionAtOpenFile(), G4Hdf5NtupleFileManager::ActionAtOpenFile(), G4RootNtupleFileManager::ActionAtOpenFile(), ActionAtOpenFile(), G4RootNtupleFileManager::CreateNtupleManager(), and G4VNtupleFileManager::SetBookingManager().

fFileManager

std::shared_ptr<G4XmlFileManager> G4XmlNtupleFileManager::fFileManager { nullptr }

private

Definition at line 71 of file G4XmlNtupleFileManager.hh.

Referenced by CloseNtupleFiles(), CreateNtupleManager(), and SetFileManager().

fFileType

G4String G4VNtupleFileManager::fFileType

protectedinherited

Definition at line 89 of file G4VNtupleFileManager.hh.

Referenced by G4VNtupleFileManager::GetFileType(), G4VNtupleFileManager::SetBasketEntries(), G4VNtupleFileManager::SetBasketSize(), G4VNtupleFileManager::SetNtupleMerging(), and G4VNtupleFileManager::SetNtupleRowWise().

fkClass

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

staticconstexprprivate

Definition at line 68 of file G4XmlNtupleFileManager.hh.

Referenced by ActionAtCloseFile().

fNtupleManager

std::shared_ptr<G4XmlNtupleManager> G4XmlNtupleFileManager::fNtupleManager { nullptr }

private

Definition at line 72 of file G4XmlNtupleFileManager.hh.

Referenced by ActionAtOpenFile(), ActionAtWrite(), CloseNtupleFiles(), CreateNtupleManager(), GetNtupleManager(), and Reset().

fState

const G4AnalysisManagerState& G4VNtupleFileManager::fState

protectedinherited

Definition at line 88 of file G4VNtupleFileManager.hh.

Referenced by G4CsvNtupleFileManager::CreateNtupleManager(), G4Hdf5NtupleFileManager::CreateNtupleManager(), G4RootNtupleFileManager::CreateNtupleManager(), CreateNtupleManager(), G4VNtupleFileManager::Message(), and G4RootNtupleFileManager::~G4RootNtupleFileManager().

---

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

• source/analysis/xml/include/G4XmlNtupleFileManager.hh
• source/analysis/xml/src/G4XmlNtupleFileManager.cc