G4VRNtupleManager Class Reference

#include <G4VRNtupleManager.hh>

Inheritance diagram for G4VRNtupleManager:

Public Member Functions
	G4VRNtupleManager ()=delete
	G4VRNtupleManager (const G4AnalysisManagerState &state)
	G4VRNtupleManager (const G4VRNtupleManager &rhs)=delete
G4int	GetFirstId () const
G4VRNtupleManager &	operator= (const G4VRNtupleManager &rhs)=delete
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
virtual	~G4VRNtupleManager ()=default

Protected Member Functions
virtual G4int	GetNofNtuples () const =0
virtual G4bool	GetNtupleRow ()=0
virtual G4bool	GetNtupleRow (G4int ntupleId)=0
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
virtual G4int	ReadNtupleImpl (const G4String &ntupleName, const G4String &fileName, const G4String &dirName, G4bool isUserFileName)=0
virtual G4bool	SetNtupleDColumn (const G4String &columnName, G4double &value)=0
virtual G4bool	SetNtupleDColumn (const G4String &columnName, std::vector< G4double > &vector)=0
virtual G4bool	SetNtupleDColumn (G4int ntupleId, const G4String &columnName, G4double &value)=0
virtual G4bool	SetNtupleDColumn (G4int ntupleId, const G4String &columnName, std::vector< G4double > &vector)=0
virtual G4bool	SetNtupleFColumn (const G4String &columnName, G4float &value)=0
virtual G4bool	SetNtupleFColumn (const G4String &columnName, std::vector< G4float > &vector)=0
virtual G4bool	SetNtupleFColumn (G4int ntupleId, const G4String &columnName, G4float &value)=0
virtual G4bool	SetNtupleFColumn (G4int ntupleId, const G4String &columnName, std::vector< G4float > &vector)=0
virtual G4bool	SetNtupleIColumn (const G4String &columnName, G4int &value)=0
virtual G4bool	SetNtupleIColumn (const G4String &columnName, std::vector< G4int > &vector)=0
virtual G4bool	SetNtupleIColumn (G4int ntupleId, const G4String &columnName, G4int &value)=0
virtual G4bool	SetNtupleIColumn (G4int ntupleId, const G4String &columnName, std::vector< G4int > &vector)=0
virtual G4bool	SetNtupleSColumn (const G4String &columnName, G4String &value)=0
virtual G4bool	SetNtupleSColumn (const G4String &columnName, std::vector< std::string > &vector)=0
virtual G4bool	SetNtupleSColumn (G4int ntupleId, const G4String &columnName, G4String &value)=0
virtual G4bool	SetNtupleSColumn (G4int ntupleId, const G4String &columnName, std::vector< std::string > &vector)=0

Protected Attributes
G4int	fFirstId { 0 }
G4bool	fLockFirstId { false }
const G4AnalysisManagerState &	fState

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

Friends
class	G4VAnalysisReader

Detailed Description

Definition at line 39 of file G4VRNtupleManager.hh.

Constructor & Destructor Documentation

G4VRNtupleManager() [1/3]

G4VRNtupleManager::G4VRNtupleManager ( const G4AnalysisManagerState &  state )

inlineexplicit

Definition at line 46 of file G4VRNtupleManager.hh.

      : G4BaseAnalysisManager(state) {}

G4VRNtupleManager() [2/3]

G4VRNtupleManager::G4VRNtupleManager ( )

delete

~G4VRNtupleManager()

virtual G4VRNtupleManager::~G4VRNtupleManager ( )

virtualdefault

G4VRNtupleManager() [3/3]

G4VRNtupleManager::G4VRNtupleManager ( const G4VRNtupleManager &  rhs )

delete

Member Function Documentation

GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const

inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

                                                     {
  return fFirstId;
}

References G4BaseAnalysisManager::fFirstId.

GetNofNtuples()

virtual G4int G4VRNtupleManager::GetNofNtuples ( ) const

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

GetNtupleRow() [1/2]

virtual G4bool G4VRNtupleManager::GetNtupleRow ( )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

GetNtupleRow() [2/2]

virtual G4bool G4VRNtupleManager::GetNtupleRow ( G4int  ntupleId )

protectedpure virtual

Implemented in G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

IsVerbose()

G4bool G4BaseAnalysisManager::IsVerbose ( G4int  verboseLevel ) const

inlineprotectedinherited

Definition at line 80 of file G4BaseAnalysisManager.hh.

{ return fState.IsVerbose(verboseLevel); }

References G4BaseAnalysisManager::fState, and G4AnalysisManagerState::IsVerbose().

Referenced by G4RootPNtupleManager::AddNtupleRow(), and G4RootPNtupleManager::Merge().

Message()

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

inlineprotectedinherited

Definition at line 83 of file G4BaseAnalysisManager.hh.

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

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

Referenced by G4RootPNtupleManager::AddNtupleRow(), G4RootPNtupleManager::Clear(), G4NtupleBookingManager::ClearData(), G4RootMainNtupleManager::ClearData(), G4NtupleBookingManager::CreateNtuple(), G4RootMainNtupleManager::CreateNtuple(), G4RootPNtupleManager::CreateNtupleFromMain(), G4RootPNtupleManager::Merge(), G4CsvRNtupleManager::ReadNtupleImpl(), G4Hdf5RNtupleManager::ReadNtupleImpl(), G4RootRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::SetNtupleDColumn(), G4XmlRNtupleManager::SetNtupleFColumn(), G4XmlRNtupleManager::SetNtupleIColumn(), and G4XmlRNtupleManager::SetNtupleSColumn().

operator=()

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

delete

ReadNtupleImpl()

virtual G4int G4VRNtupleManager::ReadNtupleImpl ( const G4String &  ntupleName, const G4String &  fileName, const G4String &  dirName, G4bool  isUserFileName  )

protectedpure virtual

Implemented in G4CsvRNtupleManager, G4Hdf5RNtupleManager, G4RootRNtupleManager, and G4XmlRNtupleManager.

SetFirstId()

G4bool G4BaseAnalysisManager::SetFirstId ( G4int  firstId )

inherited

Definition at line 46 of file G4BaseAnalysisManager.cc.

{
  if ( fLockFirstId ) {
    Warn("Cannot set FirstId as its value was already used.",
      fkClass, "SetFirstId");
 
    return false;
  }
 
  fFirstId = firstId;
  return true;
}

References G4BaseAnalysisManager::fFirstId, G4BaseAnalysisManager::fkClass, G4BaseAnalysisManager::fLockFirstId, and G4Analysis::Warn().

SetLockFirstId()

void G4BaseAnalysisManager::SetLockFirstId ( G4bool  lockFirstId )

inlineinherited

Definition at line 90 of file G4BaseAnalysisManager.hh.

                                                                    {
  fLockFirstId = lockFirstId;
}

References G4BaseAnalysisManager::fLockFirstId.

Referenced by G4HnManager::ClearData().

SetNtupleDColumn() [1/4]

virtual G4bool G4VRNtupleManager::SetNtupleDColumn ( const G4String &  columnName, G4double &  value  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleDColumn() [2/4]

virtual G4bool G4VRNtupleManager::SetNtupleDColumn ( const G4String &  columnName, std::vector< G4double > &  vector  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleDColumn() [3/4]

virtual G4bool G4VRNtupleManager::SetNtupleDColumn ( G4int  ntupleId, const G4String &  columnName, G4double &  value  )

protectedpure virtual

Implemented in G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleDColumn() [4/4]

virtual G4bool G4VRNtupleManager::SetNtupleDColumn ( G4int  ntupleId, const G4String &  columnName, std::vector< G4double > &  vector  )

protectedpure virtual

Implemented in G4XmlRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleFColumn() [1/4]

virtual G4bool G4VRNtupleManager::SetNtupleFColumn ( const G4String &  columnName, G4float &  value  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleFColumn() [2/4]

virtual G4bool G4VRNtupleManager::SetNtupleFColumn ( const G4String &  columnName, std::vector< G4float > &  vector  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleFColumn() [3/4]

virtual G4bool G4VRNtupleManager::SetNtupleFColumn ( G4int  ntupleId, const G4String &  columnName, G4float &  value  )

protectedpure virtual

Implemented in G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleFColumn() [4/4]

virtual G4bool G4VRNtupleManager::SetNtupleFColumn ( G4int  ntupleId, const G4String &  columnName, std::vector< G4float > &  vector  )

protectedpure virtual

Implemented in G4XmlRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleIColumn() [1/4]

virtual G4bool G4VRNtupleManager::SetNtupleIColumn ( const G4String &  columnName, G4int &  value  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleIColumn() [2/4]

virtual G4bool G4VRNtupleManager::SetNtupleIColumn ( const G4String &  columnName, std::vector< G4int > &  vector  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleIColumn() [3/4]

virtual G4bool G4VRNtupleManager::SetNtupleIColumn ( G4int  ntupleId, const G4String &  columnName, G4int &  value  )

protectedpure virtual

Implemented in G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleIColumn() [4/4]

virtual G4bool G4VRNtupleManager::SetNtupleIColumn ( G4int  ntupleId, const G4String &  columnName, std::vector< G4int > &  vector  )

protectedpure virtual

Implemented in G4XmlRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, and G4XmlRNtupleManager.

SetNtupleSColumn() [1/4]

virtual G4bool G4VRNtupleManager::SetNtupleSColumn ( const G4String &  columnName, G4String &  value  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

SetNtupleSColumn() [2/4]

virtual G4bool G4VRNtupleManager::SetNtupleSColumn ( const G4String &  columnName, std::vector< std::string > &  vector  )

protectedpure virtual

Implemented in G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

SetNtupleSColumn() [3/4]

virtual G4bool G4VRNtupleManager::SetNtupleSColumn ( G4int  ntupleId, const G4String &  columnName, G4String &  value  )

protectedpure virtual

Implemented in G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

SetNtupleSColumn() [4/4]

virtual G4bool G4VRNtupleManager::SetNtupleSColumn ( G4int  ntupleId, const G4String &  columnName, std::vector< std::string > &  vector  )

protectedpure virtual

Implemented in G4XmlRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, G4TRNtupleManager< tools::aida::ntuple >, G4BaseRNtupleManager, G4TRNtupleManager< NT >, G4TRNtupleManager< tools::rcsv::ntuple >, G4TRNtupleManager< tools::hdf5::ntuple >, G4TRNtupleManager< tools::rroot::ntuple >, and G4TRNtupleManager< tools::aida::ntuple >.

Friends And Related Function Documentation

G4VAnalysisReader

friend class G4VAnalysisReader

friend

Definition at line 43 of file G4VRNtupleManager.hh.

Field Documentation

fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }

protectedinherited

Definition at line 70 of file G4BaseAnalysisManager.hh.

Referenced by G4BaseNtupleManager::AddNtupleRow(), G4NtupleBookingManager::CreateNtuple(), G4BaseNtupleManager::FillNtupleDColumn(), G4BaseNtupleManager::FillNtupleFColumn(), G4BaseNtupleManager::FillNtupleIColumn(), G4BaseRNtupleManager::GetCurrentNtupleId(), G4BaseAnalysisManager::GetFirstId(), G4HnManager::GetHnInformation(), G4RootPNtupleManager::GetMainNtupleInFunction(), G4NtupleBookingManager::GetNtupleBookingInFunction(), G4RootPNtupleManager::GetNtupleDescriptionInFunction(), G4BaseRNtupleManager::GetNtupleRow(), and G4BaseAnalysisManager::SetFirstId().

fkClass

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

staticconstexprprivateinherited

Definition at line 75 of file G4BaseAnalysisManager.hh.

Referenced by G4BaseAnalysisManager::SetFirstId().

fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }

protectedinherited

Definition at line 71 of file G4BaseAnalysisManager.hh.

Referenced by G4NtupleBookingManager::CreateNtuple(), G4BaseAnalysisManager::SetFirstId(), and G4BaseAnalysisManager::SetLockFirstId().

fState

const G4AnalysisManagerState& G4BaseAnalysisManager::fState

protectedinherited

Definition at line 69 of file G4BaseAnalysisManager.hh.

Referenced by G4RootPNtupleManager::AddNtupleRow(), G4RootNtupleManager::G4RootNtupleManager(), G4BaseAnalysisManager::IsVerbose(), and G4BaseAnalysisManager::Message().

---

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

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