Geant4 11.2.2
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
Public Member Functions | List of all members
G4TNtupleDescription< NT, FT > Class Template Reference

#include <G4TNtupleDescription.hh>

Public Member Functions

 G4TNtupleDescription (G4NtupleBooking *g4NtupleBooking)
 
 G4TNtupleDescription ()=delete
 
 ~G4TNtupleDescription ()
 
void SetFile (std::shared_ptr< FT > file)
 
void SetNtuple (NT *ntuple)
 
void SetFileName (const G4String &fileName)
 
void SetActivation (G4bool activation)
 
void SetIsNtupleOwner (G4bool isNtupleOwner)
 
void SetHasFill (G4bool hasFill)
 
void Reset ()
 
std::shared_ptr< FT > GetFile () const
 
NT * GetNtuple () const
 
G4NtupleBooking * GetG4NtupleBooking () const
 
const tools::ntuple_booking & GetNtupleBooking () const
 
G4String GetFileName () const
 
G4bool GetActivation () const
 
G4bool GetIsNtupleOwner () const
 
G4bool GetHasFill () const
 

Detailed Description

template<typename NT, typename FT>
class G4TNtupleDescription< NT, FT >

Definition at line 41 of file G4TNtupleDescription.hh.

Constructor & Destructor Documentation

◆ G4TNtupleDescription() [1/2]

template<typename NT , typename FT >
G4TNtupleDescription< NT, FT >::G4TNtupleDescription ( G4NtupleBooking * g4NtupleBooking)
inline

Definition at line 44 of file G4TNtupleDescription.hh.

45 : fG4NtupleBooking(g4NtupleBooking)
46 {}

◆ G4TNtupleDescription() [2/2]

template<typename NT , typename FT >
G4TNtupleDescription< NT, FT >::G4TNtupleDescription ( )
delete

◆ ~G4TNtupleDescription()

template<typename NT , typename FT >
G4TNtupleDescription< NT, FT >::~G4TNtupleDescription ( )
inline

Definition at line 49 of file G4TNtupleDescription.hh.

50 {
51 if ( fIsNtupleOwner ) delete fNtuple;
52 }

Member Function Documentation

◆ GetActivation()

template<typename NT , typename FT >
G4bool G4TNtupleDescription< NT, FT >::GetActivation ( ) const

Definition at line 138 of file G4TNtupleDescription.hh.

139{ return fG4NtupleBooking->fActivation; }

◆ GetFile()

template<typename NT , typename FT >
std::shared_ptr< FT > G4TNtupleDescription< NT, FT >::GetFile ( ) const

Definition at line 116 of file G4TNtupleDescription.hh.

117{ return fFile; }

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

◆ GetFileName()

template<typename NT , typename FT >
G4String G4TNtupleDescription< NT, FT >::GetFileName ( ) const

Definition at line 134 of file G4TNtupleDescription.hh.

135{ return fG4NtupleBooking->fFileName; }

◆ GetG4NtupleBooking()

template<typename NT , typename FT >
G4NtupleBooking * G4TNtupleDescription< NT, FT >::GetG4NtupleBooking ( ) const

Definition at line 125 of file G4TNtupleDescription.hh.

126{ return fG4NtupleBooking; }

Referenced by G4RootMainNtupleManager::CreateNtuple().

◆ GetHasFill()

template<typename NT , typename FT >
G4bool G4TNtupleDescription< NT, FT >::GetHasFill ( ) const

Definition at line 146 of file G4TNtupleDescription.hh.

147{ return fHasFill; }

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

◆ GetIsNtupleOwner()

template<typename NT , typename FT >
G4bool G4TNtupleDescription< NT, FT >::GetIsNtupleOwner ( ) const

Definition at line 142 of file G4TNtupleDescription.hh.

143{ return fIsNtupleOwner; }

Referenced by G4RootPNtupleDescription::Reset(), and G4RootPNtupleDescription::~G4RootPNtupleDescription().

◆ GetNtuple()

template<typename NT , typename FT >
NT * G4TNtupleDescription< NT, FT >::GetNtuple ( ) const

Definition at line 120 of file G4TNtupleDescription.hh.

121{ return fNtuple; }

◆ GetNtupleBooking()

template<typename NT , typename FT >
const tools::ntuple_booking & G4TNtupleDescription< NT, FT >::GetNtupleBooking ( ) const

Definition at line 130 of file G4TNtupleDescription.hh.

131{ return fG4NtupleBooking->fNtupleBooking; }
G4NtupleBooking::fNtupleBooking
tools::ntuple_booking fNtupleBooking
Definition G4NtupleBookingManager.hh:64

◆ Reset()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::Reset ( )

Definition at line 109 of file G4TNtupleDescription.hh.

110{
111 if (fIsNtupleOwner) delete fNtuple;
112 fNtuple = nullptr;
113}

◆ SetActivation()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::SetActivation ( G4bool activation)

Definition at line 97 of file G4TNtupleDescription.hh.

98{ fG4NtupleBooking->fActivation = activation; }

◆ SetFile()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::SetFile ( std::shared_ptr< FT > file)

Definition at line 85 of file G4TNtupleDescription.hh.

86{ fFile = file; }

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

◆ SetFileName()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::SetFileName ( const G4String & fileName)

Definition at line 93 of file G4TNtupleDescription.hh.

94{ fG4NtupleBooking->fFileName = fileName; }

Referenced by G4CsvFileManager::CreateNtupleFile().

◆ SetHasFill()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::SetHasFill ( G4bool hasFill)

Definition at line 105 of file G4TNtupleDescription.hh.

106{ fHasFill = hasFill; }

◆ SetIsNtupleOwner()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::SetIsNtupleOwner ( G4bool isNtupleOwner)

Definition at line 101 of file G4TNtupleDescription.hh.

102{ fIsNtupleOwner = isNtupleOwner; }

◆ SetNtuple()

template<typename NT , typename FT >
void G4TNtupleDescription< NT, FT >::SetNtuple ( NT * ntuple)

Definition at line 89 of file G4TNtupleDescription.hh.

90{ fNtuple = ntuple; }
The documentation for this class was generated from the following file: