G4NtupleBookingManager Class Reference

#include <G4NtupleBookingManager.hh>

Inheritance diagram for G4NtupleBookingManager:

Public Member Functions
	G4NtupleBookingManager ()=delete
	G4NtupleBookingManager (const G4AnalysisManagerState &state)
G4String	GetFileType () const
G4int	GetFirstId () const
const std::vector< G4NtupleBooking * > &	GetNtupleBookingVector () const
G4bool	IsEmpty () const
void	SetFileType (const G4String &fileType)
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
	~G4NtupleBookingManager ()

Protected Member Functions
void	ClearData ()
G4int	CreateNtuple (const G4String &name, const G4String &title)
G4int	CreateNtupleDColumn (const G4String &name, std::vector< double > *vector)
G4int	CreateNtupleDColumn (G4int ntupleId, const G4String &name, std::vector< double > *vector)
G4int	CreateNtupleFColumn (const G4String &name, std::vector< float > *vector)
G4int	CreateNtupleFColumn (G4int ntupleId, const G4String &name, std::vector< float > *vector)
G4int	CreateNtupleIColumn (const G4String &name, std::vector< int > *vector)
G4int	CreateNtupleIColumn (G4int ntupleId, const G4String &name, std::vector< int > *vector)
G4int	CreateNtupleSColumn (const G4String &name, std::vector< std::string > *vector)
G4int	CreateNtupleSColumn (G4int ntupleId, const G4String &name, std::vector< std::string > *vector)
G4NtupleBooking *	FinishNtuple ()
G4NtupleBooking *	FinishNtuple (G4int ntupleId)
G4bool	GetActivation (G4int ntupleId) const
G4String	GetFileName (G4int id) const
G4int	GetFirstNtupleColumnId () const
G4int	GetNofNtupleBookings () const
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
void	SetActivation (G4bool activation)
void	SetActivation (G4int ntupleId, G4bool activation)
void	SetFileName (const G4String &fileName)
void	SetFileName (G4int id, const G4String &fileName)
G4bool	SetFirstNtupleColumnId (G4int firstId)

Protected Attributes
G4int	fFirstId { 0 }
G4bool	fLockFirstId { false }
std::vector< G4NtupleBooking * >	fNtupleBookingVector
const G4AnalysisManagerState &	fState

Private Member Functions
template<typename T >
G4int	CreateNtupleTColumn (G4int ntupleId, const G4String &name, std::vector< T > *vector)
G4int	GetCurrentNtupleId () const
G4NtupleBooking *	GetNtupleBookingInFunction (G4int id, std::string_view function, G4bool warn=true) const

Private Attributes
G4String	fFileType
G4int	fFirstNtupleColumnId { 0 }
G4bool	fLockFirstNtupleColumnId { false }

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

Friends
class	G4VAnalysisManager

Detailed Description

Definition at line 54 of file G4NtupleBookingManager.hh.

Constructor & Destructor Documentation

G4NtupleBookingManager() [1/2]

G4NtupleBookingManager::G4NtupleBookingManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 41 of file G4NtupleBookingManager.cc.

  : G4BaseAnalysisManager(state)
{}

G4NtupleBookingManager() [2/2]

G4NtupleBookingManager::G4NtupleBookingManager ( )

delete

~G4NtupleBookingManager()

G4NtupleBookingManager::~G4NtupleBookingManager

(

)

Definition at line 47 of file G4NtupleBookingManager.cc.

{
  for ( auto ntupleBooking : fNtupleBookingVector ) {
    delete ntupleBooking;
  }
}

References fNtupleBookingVector.

Member Function Documentation

ClearData()

void G4NtupleBookingManager::ClearData ( )

protected

Definition at line 276 of file G4NtupleBookingManager.cc.

{
  for ( auto ntupleBooking : fNtupleBookingVector ) {
    delete ntupleBooking;
  }
  fNtupleBookingVector.clear();
  fLockFirstNtupleColumnId = false;
 
  Message(G4Analysis::kVL2, "clear", "ntupleBookings");
}

References fLockFirstNtupleColumnId, fNtupleBookingVector, G4Analysis::kVL2, and G4BaseAnalysisManager::Message().

CreateNtuple()

G4int G4NtupleBookingManager::CreateNtuple ( const G4String &  name, const G4String &  title  )

protected

Definition at line 82 of file G4NtupleBookingManager.cc.

{
  Message(kVL4, "create", "ntuple booking", name);
 
  // Create ntuple description
  auto index = fNtupleBookingVector.size();
  auto ntupleBooking = new G4NtupleBooking();
  fNtupleBookingVector.push_back(ntupleBooking);
 
  // Save name & title in ntuple booking
  ntupleBooking->fNtupleBooking.set_name(name);
  ntupleBooking->fNtupleBooking.set_title(title);
  ntupleBooking->fNtupleId = G4int(index + fFirstId);
 
  // Create ntuple
  fLockFirstId = true;
 
  Message(kVL2, "create", "ntuple booking",
    name +  " ntupleId " + to_string(ntupleBooking->fNtupleId));
 
  return ntupleBooking->fNtupleId;
}

References G4BaseAnalysisManager::fFirstId, G4BaseAnalysisManager::fLockFirstId, fNtupleBookingVector, G4Analysis::kVL2, G4Analysis::kVL4, G4BaseAnalysisManager::Message(), and G4InuclParticleNames::name().

CreateNtupleDColumn() [1/2]

G4int G4NtupleBookingManager::CreateNtupleDColumn ( const G4String &  name, std::vector< double > *  vector  )

protected

Definition at line 121 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleDColumn(GetCurrentNtupleId(), name, vector);
}

References CreateNtupleDColumn(), GetCurrentNtupleId(), and G4InuclParticleNames::name().

Referenced by CreateNtupleDColumn().

CreateNtupleDColumn() [2/2]

G4int G4NtupleBookingManager::CreateNtupleDColumn ( G4int  ntupleId, const G4String &  name, std::vector< double > *  vector  )

protected

Definition at line 155 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleTColumn<double>(ntupleId, name, vector);
}

References G4InuclParticleNames::name().

CreateNtupleFColumn() [1/2]

G4int G4NtupleBookingManager::CreateNtupleFColumn ( const G4String &  name, std::vector< float > *  vector  )

protected

Definition at line 114 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleFColumn(GetCurrentNtupleId(), name, vector);
}

References CreateNtupleFColumn(), GetCurrentNtupleId(), and G4InuclParticleNames::name().

Referenced by CreateNtupleFColumn().

CreateNtupleFColumn() [2/2]

G4int G4NtupleBookingManager::CreateNtupleFColumn ( G4int  ntupleId, const G4String &  name, std::vector< float > *  vector  )

protected

Definition at line 148 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleTColumn<float>(ntupleId, name, vector);
}

References G4InuclParticleNames::name().

CreateNtupleIColumn() [1/2]

G4int G4NtupleBookingManager::CreateNtupleIColumn ( const G4String &  name, std::vector< int > *  vector  )

protected

Definition at line 107 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleIColumn(GetCurrentNtupleId(), name, vector);
}

References CreateNtupleIColumn(), GetCurrentNtupleId(), and G4InuclParticleNames::name().

Referenced by CreateNtupleIColumn().

CreateNtupleIColumn() [2/2]

G4int G4NtupleBookingManager::CreateNtupleIColumn ( G4int  ntupleId, const G4String &  name, std::vector< int > *  vector  )

protected

Definition at line 141 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleTColumn<int>(ntupleId, name, vector);
}

References G4InuclParticleNames::name().

CreateNtupleSColumn() [1/2]

G4int G4NtupleBookingManager::CreateNtupleSColumn ( const G4String &  name, std::vector< std::string > *  vector  )

protected

Definition at line 128 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleSColumn(GetCurrentNtupleId(), name, vector);
}

References CreateNtupleSColumn(), GetCurrentNtupleId(), and G4InuclParticleNames::name().

Referenced by CreateNtupleSColumn().

CreateNtupleSColumn() [2/2]

G4int G4NtupleBookingManager::CreateNtupleSColumn ( G4int  ntupleId, const G4String &  name, std::vector< std::string > *  vector  )

protected

Definition at line 162 of file G4NtupleBookingManager.cc.

{
  return CreateNtupleTColumn<std::string>(ntupleId, name, vector);
}

References G4InuclParticleNames::name().

CreateNtupleTColumn()

template<typename T >

G4int G4NtupleBookingManager::CreateNtupleTColumn ( G4int  ntupleId, const G4String &  name, std::vector< T > *  vector  )

private

FinishNtuple() [1/2]

G4NtupleBooking * G4NtupleBookingManager::FinishNtuple ( )

protected

Definition at line 135 of file G4NtupleBookingManager.cc.

{
  return FinishNtuple(GetCurrentNtupleId());
}

References FinishNtuple(), and GetCurrentNtupleId().

Referenced by FinishNtuple().

FinishNtuple() [2/2]

G4NtupleBooking * G4NtupleBookingManager::FinishNtuple ( G4int  ntupleId )

protected

Definition at line 169 of file G4NtupleBookingManager.cc.

{
  // Nothing to be done for booking,
  return GetNtupleBookingInFunction(ntupleId, "FinishNtuple");
}

References GetNtupleBookingInFunction().

GetActivation()

G4bool G4NtupleBookingManager::GetActivation ( G4int  ntupleId ) const

protected

Definition at line 210 of file G4NtupleBookingManager.cc.

{
  auto ntupleBooking
    = GetNtupleBookingInFunction(ntupleId, "GetActivation");
  if ( ! ntupleBooking ) return false;
 
  return ntupleBooking->fActivation;
}

References GetNtupleBookingInFunction().

GetCurrentNtupleId()

G4int G4NtupleBookingManager::GetCurrentNtupleId ( ) const

private

Referenced by CreateNtupleDColumn(), CreateNtupleFColumn(), CreateNtupleIColumn(), CreateNtupleSColumn(), and FinishNtuple().

GetFileName()

G4String G4NtupleBookingManager::GetFileName ( G4int  id ) const

protected

Definition at line 265 of file G4NtupleBookingManager.cc.

{
  auto ntupleBooking
    = GetNtupleBookingInFunction(ntupleId, "GetFileName");
  if ( ! ntupleBooking ) return "";
 
  return ntupleBooking->fFileName;
}

References GetNtupleBookingInFunction().

GetFileType()

G4String G4NtupleBookingManager::GetFileType

(

)

const

GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const

inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

                                                     {
  return fFirstId;
}

References G4BaseAnalysisManager::fFirstId.

GetFirstNtupleColumnId()

G4int G4NtupleBookingManager::GetFirstNtupleColumnId ( ) const

protected

GetNofNtupleBookings()

G4int G4NtupleBookingManager::GetNofNtupleBookings ( ) const

protected

GetNtupleBookingInFunction()

G4NtupleBooking * G4NtupleBookingManager::GetNtupleBookingInFunction ( G4int  id, std::string_view  function, G4bool  warn = true  ) const

private

Definition at line 56 of file G4NtupleBookingManager.cc.

{
  auto index = id - fFirstId;
  if ( index < 0 || index >= G4int(fNtupleBookingVector.size()) ) {
    if ( warn) {
      Warn("Ntuple booking " + to_string(id) + " does not exist.",
        fkClass, functionName);
    }
    return nullptr;
  }
 
  return fNtupleBookingVector[index];
}

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

Referenced by FinishNtuple(), GetActivation(), GetFileName(), SetActivation(), and SetFileName().

GetNtupleBookingVector()

const std::vector< G4NtupleBooking * > & G4NtupleBookingManager::GetNtupleBookingVector

(

)

const

IsEmpty()

G4bool G4NtupleBookingManager::IsEmpty

(

)

const

Definition at line 76 of file G4NtupleBookingManager.cc.

{
  return ! fNtupleBookingVector.size();
}

References fNtupleBookingVector.

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(), ClearData(), G4RootMainNtupleManager::ClearData(), CreateNtuple(), G4RootMainNtupleManager::CreateNtuple(), G4RootPNtupleManager::CreateNtupleFromMain(), G4RootPNtupleManager::Merge(), G4CsvRNtupleManager::ReadNtupleImpl(), G4Hdf5RNtupleManager::ReadNtupleImpl(), G4RootRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::SetNtupleDColumn(), G4XmlRNtupleManager::SetNtupleFColumn(), G4XmlRNtupleManager::SetNtupleIColumn(), and G4XmlRNtupleManager::SetNtupleSColumn().

SetActivation() [1/2]

void G4NtupleBookingManager::SetActivation ( G4bool  activation )

protected

Definition at line 190 of file G4NtupleBookingManager.cc.

{
  for ( auto ntupleBooking : fNtupleBookingVector ) {
    ntupleBooking->fActivation = activation;
  }
}

References fNtupleBookingVector.

SetActivation() [2/2]

void G4NtupleBookingManager::SetActivation ( G4int  ntupleId, G4bool  activation  )

protected

Definition at line 199 of file G4NtupleBookingManager.cc.

{
  auto ntupleBooking
    = GetNtupleBookingInFunction(ntupleId, "SetActivation");
  if ( ! ntupleBooking ) return;
 
  ntupleBooking->fActivation = activation;
}

References GetNtupleBookingInFunction().

SetFileName() [1/2]

void G4NtupleBookingManager::SetFileName ( const G4String &  fileName )

protected

Definition at line 221 of file G4NtupleBookingManager.cc.

{
  for ( auto ntupleBooking : fNtupleBookingVector ) {
    ntupleBooking->fFileName = fileName;
  }
}

References fNtupleBookingVector.

SetFileName() [2/2]

void G4NtupleBookingManager::SetFileName ( G4int  id, const G4String &  fileName  )

protected

Definition at line 230 of file G4NtupleBookingManager.cc.

{
  auto ntupleBooking
    = GetNtupleBookingInFunction(ntupleId, "SetFileName");
  if ( ! ntupleBooking ) return;
 
  // Do nothing if file name does not change
  if ( ntupleBooking->fFileName == fileName ) return;
 
  auto ntupleFileName = fileName;
  auto extension = GetExtension(fileName);
  if ( extension.size() ) {
    // Check if valid extension (if present)
    auto output = G4Analysis::GetOutput(extension);
    if ( output == G4AnalysisOutput::kNone ) {
      Warn("The file extension " + extension + " is not supported.",
        fkClass, "SetFileName");
      return;
    }
  }
  else {
    if ( fFileType.size() ) {
      //add extension if missing and file type is defined
      ntupleFileName = fileName + "." + fFileType;
    }
  }
 
  // Save the fileName in booking
  // If extension is still missing (possible with generic manager),
  // it will be completed with the default one at OpenFile
  ntupleBooking->fFileName = ntupleFileName;
}

References fFileType, fkClass, G4Analysis::GetExtension(), GetNtupleBookingInFunction(), G4Analysis::GetOutput(), kNone, and G4Analysis::Warn().

SetFileType()

void G4NtupleBookingManager::SetFileType

(

const G4String &

fileType

)

Definition at line 292 of file G4NtupleBookingManager.cc.

{
  // do nothing if file type is defined and is same
  if ( fFileType == fileType ) return;
 
  // save the type
  fFileType = fileType;
 
  // Give warning and redefine file extension in bookings
  // with file name of different fileTypes
  for ( auto ntupleBooking : fNtupleBookingVector ) {
 
    if ( ! (ntupleBooking->fFileName).size() ) continue;
 
    auto extension = GetExtension(ntupleBooking->fFileName);
    if ( fFileType == extension ) continue;
 
    // multiple file types are not suported
    auto baseFileName = GetBaseName(ntupleBooking->fFileName);
    auto ntupleFileName = baseFileName + "." + fFileType;
    if ( extension.size() ) {
      Warn("Writing ntuples in files of different output types " +
           fFileType + ", " + extension + " is not supported.",
           fkClass, "SetFileType");
    }
 
    // Save the info in ntuple description
    ntupleBooking->fFileName = ntupleFileName;
  }
}

References fFileType, fkClass, fNtupleBookingVector, G4Analysis::GetBaseName(), G4Analysis::GetExtension(), and G4Analysis::Warn().

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

SetFirstNtupleColumnId()

G4bool G4NtupleBookingManager::SetFirstNtupleColumnId ( G4int  firstId )

protected

Definition at line 177 of file G4NtupleBookingManager.cc.

{
  if ( fLockFirstNtupleColumnId ) {
    Warn("Cannot set FirstNtupleColumnId as its value was already used.",
      fkClass, "SetFirstNtupleColumnId");
    return false;
  }
 
  fFirstNtupleColumnId = firstId;
  return true;
}

References fFirstNtupleColumnId, fkClass, fLockFirstNtupleColumnId, 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().

Friends And Related Function Documentation

G4VAnalysisManager

friend class G4VAnalysisManager

friend

Definition at line 58 of file G4NtupleBookingManager.hh.

Field Documentation

fFileType

G4String G4NtupleBookingManager::fFileType

private

Definition at line 144 of file G4NtupleBookingManager.hh.

Referenced by SetFileName(), and SetFileType().

fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }

protectedinherited

Definition at line 70 of file G4BaseAnalysisManager.hh.

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

fFirstNtupleColumnId

G4int G4NtupleBookingManager::fFirstNtupleColumnId { 0 }

private

Definition at line 145 of file G4NtupleBookingManager.hh.

Referenced by SetFirstNtupleColumnId().

fkClass

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

staticconstexprprivate

Definition at line 141 of file G4NtupleBookingManager.hh.

Referenced by GetNtupleBookingInFunction(), SetFileName(), SetFileType(), and SetFirstNtupleColumnId().

fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }

protectedinherited

Definition at line 71 of file G4BaseAnalysisManager.hh.

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

fLockFirstNtupleColumnId

G4bool G4NtupleBookingManager::fLockFirstNtupleColumnId { false }

private

Definition at line 146 of file G4NtupleBookingManager.hh.

Referenced by ClearData(), and SetFirstNtupleColumnId().

fNtupleBookingVector

std::vector<G4NtupleBooking*> G4NtupleBookingManager::fNtupleBookingVector

protected

Definition at line 126 of file G4NtupleBookingManager.hh.

Referenced by ClearData(), CreateNtuple(), GetNtupleBookingInFunction(), IsEmpty(), SetActivation(), SetFileName(), SetFileType(), and ~G4NtupleBookingManager().

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

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