G4VNtupleFileManager Class Reference

#include <G4VNtupleFileManager.hh>

Inheritance diagram for G4VNtupleFileManager:

Public Member Functions
virtual G4bool	ActionAtCloseFile (G4bool)=0
virtual G4bool	ActionAtOpenFile (const G4String &)=0
virtual G4bool	ActionAtWrite ()=0
virtual std::shared_ptr< G4VNtupleManager >	CreateNtupleManager ()=0
	G4VNtupleFileManager ()=delete
	G4VNtupleFileManager (const G4AnalysisManagerState &state, const G4String &fileType)
	G4VNtupleFileManager (const G4VNtupleFileManager &rhs)=delete
G4String	GetFileType () const
virtual G4bool	IsNtupleMergingSupported () const
G4VNtupleFileManager &	operator= (const G4VNtupleFileManager &rhs)=delete
virtual G4bool	Reset ()=0
virtual void	SetBasketEntries (unsigned int basketEntries)
virtual void	SetBasketSize (unsigned int basketSize)
virtual void	SetBookingManager (std::shared_ptr< G4NtupleBookingManager > bookingManager)
virtual void	SetNtupleMerging (G4bool mergeNtuples, G4int nofReducedNtupleFiles=0)
virtual void	SetNtupleRowWise (G4bool rowWise, G4bool rowMode=true)
virtual	~G4VNtupleFileManager ()=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

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

Friends
class	G4VAnalysisManager

Detailed Description

Definition at line 43 of file G4VNtupleFileManager.hh.

Constructor & Destructor Documentation

G4VNtupleFileManager() [1/3]

G4VNtupleFileManager::G4VNtupleFileManager	(	const G4AnalysisManagerState &	state,
		const G4String &	fileType
	)

Definition at line 49 of file G4VNtupleFileManager.cc.

 : fState(state),
   fFileType(fileType)
{}

G4VNtupleFileManager() [2/3]

G4VNtupleFileManager::G4VNtupleFileManager ( )

delete

~G4VNtupleFileManager()

virtual G4VNtupleFileManager::~G4VNtupleFileManager ( )

virtualdefault

G4VNtupleFileManager() [3/3]

G4VNtupleFileManager::G4VNtupleFileManager ( const G4VNtupleFileManager &  rhs )

delete

Member Function Documentation

ActionAtCloseFile()

virtual G4bool G4VNtupleFileManager::ActionAtCloseFile ( G4bool  )

pure virtual

Implemented in G4CsvNtupleFileManager, G4Hdf5NtupleFileManager, G4RootNtupleFileManager, and G4XmlNtupleFileManager.

ActionAtOpenFile()

virtual G4bool G4VNtupleFileManager::ActionAtOpenFile ( const G4String &  )

pure virtual

Implemented in G4CsvNtupleFileManager, G4Hdf5NtupleFileManager, G4RootNtupleFileManager, and G4XmlNtupleFileManager.

ActionAtWrite()

virtual G4bool G4VNtupleFileManager::ActionAtWrite ( )

pure virtual

Implemented in G4CsvNtupleFileManager, G4Hdf5NtupleFileManager, G4RootNtupleFileManager, and G4XmlNtupleFileManager.

CreateNtupleManager()

virtual std::shared_ptr< G4VNtupleManager > G4VNtupleFileManager::CreateNtupleManager ( )

pure virtual

Implemented in G4CsvNtupleFileManager, G4Hdf5NtupleFileManager, G4RootNtupleFileManager, and G4XmlNtupleFileManager.

GetFileType()

G4String G4VNtupleFileManager::GetFileType ( ) const

inline

Definition at line 107 of file G4VNtupleFileManager.hh.

                                                        {
  return fFileType;
}

References fFileType.

IsNtupleMergingSupported()

G4bool G4VNtupleFileManager::IsNtupleMergingSupported ( ) const

inlinevirtual

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

inlineprotected

Definition at line 111 of file G4VNtupleFileManager.hh.

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

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

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

operator=()

G4VNtupleFileManager & G4VNtupleFileManager::operator= ( const G4VNtupleFileManager &  rhs )

delete

Reset()

virtual G4bool G4VNtupleFileManager::Reset ( )

pure virtual

Implemented in G4CsvNtupleFileManager, G4Hdf5NtupleFileManager, G4RootNtupleFileManager, and G4XmlNtupleFileManager.

SetBasketEntries()

void G4VNtupleFileManager::SetBasketEntries ( unsigned int  basketEntries )

virtual

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 fFileType, fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

SetBasketSize()

void G4VNtupleFileManager::SetBasketSize ( unsigned int  basketSize )

virtual

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 fFileType, fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

SetBookingManager()

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

inlinevirtual

Definition at line 99 of file G4VNtupleFileManager.hh.

{ fBookingManager = bookingManager; }

References fBookingManager.

SetNtupleMerging()

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

virtual

---

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 fFileType, fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

SetNtupleRowWise()

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

virtual

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 fFileType, fkClass, and anonymous_namespace{G4VNtupleFileManager.cc}::NtupleMergingWarning().

Friends And Related Function Documentation

G4VAnalysisManager

friend class G4VAnalysisManager

friend

Definition at line 47 of file G4VNtupleFileManager.hh.

Field Documentation

fBookingManager

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

protected

Definition at line 90 of file G4VNtupleFileManager.hh.

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

fFileType

G4String G4VNtupleFileManager::fFileType

protected

Definition at line 89 of file G4VNtupleFileManager.hh.

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

fkClass

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

staticconstexprprivate

Definition at line 94 of file G4VNtupleFileManager.hh.

Referenced by SetBasketEntries(), SetBasketSize(), SetNtupleMerging(), and SetNtupleRowWise().

fState

const G4AnalysisManagerState& G4VNtupleFileManager::fState

protected

Definition at line 88 of file G4VNtupleFileManager.hh.

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

---

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

• source/analysis/management/include/G4VNtupleFileManager.hh
• source/analysis/management/src/G4VNtupleFileManager.cc