G4NtupleBookingManager Class Reference

#include <G4NtupleBookingManager.hh>

Inheritance diagram for G4NtupleBookingManager:

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

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

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

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

override

Definition at line 47 of file G4NtupleBookingManager.cc.

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

Member Function Documentation

ClearData()

void G4NtupleBookingManager::ClearData ( )

protected

Definition at line 290 of file G4NtupleBookingManager.cc.

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

CreateNtuple()

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

protected

Definition at line 94 of file G4NtupleBookingManager.cc.

{
  if ( ! CheckName(name, "Ntuple") ) return kInvalidId;
 
  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;
}

CreateNtupleDColumn() [1/2]

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

protected

Definition at line 135 of file G4NtupleBookingManager.cc.

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

Referenced by CreateNtupleDColumn().

CreateNtupleDColumn() [2/2]

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

protected

Definition at line 169 of file G4NtupleBookingManager.cc.

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

CreateNtupleFColumn() [1/2]

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

protected

Definition at line 128 of file G4NtupleBookingManager.cc.

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

Referenced by CreateNtupleFColumn().

CreateNtupleFColumn() [2/2]

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

protected

Definition at line 162 of file G4NtupleBookingManager.cc.

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

CreateNtupleIColumn() [1/2]

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

protected

Definition at line 121 of file G4NtupleBookingManager.cc.

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

Referenced by CreateNtupleIColumn().

CreateNtupleIColumn() [2/2]

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

protected

Definition at line 155 of file G4NtupleBookingManager.cc.

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

CreateNtupleSColumn() [1/2]

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

protected

Definition at line 142 of file G4NtupleBookingManager.cc.

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

Referenced by CreateNtupleSColumn().

CreateNtupleSColumn() [2/2]

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

protected

Definition at line 176 of file G4NtupleBookingManager.cc.

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

FinishNtuple() [1/2]

G4NtupleBooking * G4NtupleBookingManager::FinishNtuple ( )

protected

Definition at line 149 of file G4NtupleBookingManager.cc.

{
  return FinishNtuple(GetCurrentNtupleId());
}

Referenced by FinishNtuple().

FinishNtuple() [2/2]

G4NtupleBooking * G4NtupleBookingManager::FinishNtuple ( G4int  ntupleId )

protected

Definition at line 183 of file G4NtupleBookingManager.cc.

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

GetActivation()

G4bool G4NtupleBookingManager::GetActivation ( G4int  ntupleId ) const

protected

Definition at line 224 of file G4NtupleBookingManager.cc.

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

GetFileName()

G4String G4NtupleBookingManager::GetFileName ( G4int  id ) const

protected

Definition at line 279 of file G4NtupleBookingManager.cc.

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

GetFileType()

G4String G4NtupleBookingManager::GetFileType

(

)

const

GetFirstNtupleColumnId()

G4int G4NtupleBookingManager::GetFirstNtupleColumnId ( ) const

protected

GetNofNtupleBookings()

G4int G4NtupleBookingManager::GetNofNtupleBookings ( ) const

protected

GetNtupleBookingVector()

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

(

)

const

IsEmpty()

G4bool G4NtupleBookingManager::IsEmpty

(

)

const

Definition at line 88 of file G4NtupleBookingManager.cc.

{
  return fNtupleBookingVector.size() == 0u;
}

SetActivation() [1/2]

void G4NtupleBookingManager::SetActivation ( G4bool  activation )

protected

Definition at line 204 of file G4NtupleBookingManager.cc.

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

SetActivation() [2/2]

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

protected

Definition at line 213 of file G4NtupleBookingManager.cc.

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

SetFileName() [1/2]

void G4NtupleBookingManager::SetFileName ( const G4String &  fileName )

protected

Definition at line 235 of file G4NtupleBookingManager.cc.

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

SetFileName() [2/2]

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

protected

Definition at line 244 of file G4NtupleBookingManager.cc.

{
  auto ntupleBooking
    = GetNtupleBookingInFunction(ntupleId, "SetFileName");
  if (ntupleBooking == nullptr) return;
 
  // Do nothing if file name does not change
  if ( ntupleBooking->fFileName == fileName ) return;
 
  auto ntupleFileName = fileName;
  auto extension = GetExtension(fileName);
  if (extension.size() != 0u) {
    // 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() != 0u) {
      //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;
}

SetFileType()

void G4NtupleBookingManager::SetFileType

(

const G4String &

fileType

)

Definition at line 306 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() == 0u) 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() != 0u) {
      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;
  }
}

SetFirstNtupleColumnId()

G4bool G4NtupleBookingManager::SetFirstNtupleColumnId ( G4int  firstId )

protected

Definition at line 191 of file G4NtupleBookingManager.cc.

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

Friends And Related Function Documentation

G4VAnalysisManager

friend class G4VAnalysisManager

friend

Definition at line 58 of file G4NtupleBookingManager.hh.

Member Data Documentation

fNtupleBookingVector

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

protected

Definition at line 126 of file G4NtupleBookingManager.hh.

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

---

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

• G4NtupleBookingManager.hh
• G4NtupleBookingManager.cc