G4NtupleBookingManager Class Reference

#include <G4NtupleBookingManager.hh>

Inheritance diagram for G4NtupleBookingManager:

Public Member Functions
	G4NtupleBookingManager (const G4AnalysisManagerState &state)
	~G4NtupleBookingManager ()
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)
virtual	~G4BaseAnalysisManager ()
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
G4int	GetFirstId () 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)
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)
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

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

Friends
class	G4VAnalysisManager

Detailed Description

Definition at line 55 of file G4NtupleBookingManager.hh.

Constructor & Destructor Documentation

G4NtupleBookingManager()

G4NtupleBookingManager::G4NtupleBookingManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 40 of file G4NtupleBookingManager.cc.

  : G4BaseAnalysisManager(state),
    fNtupleBookingVector(),
    fFileType(),
    fFirstNtupleColumnId(0),
    fLockFirstNtupleColumnId(false)    
{}

~G4NtupleBookingManager()

G4NtupleBookingManager::~G4NtupleBookingManager

(

)

Definition at line 50 of file G4NtupleBookingManager.cc.

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

Member Function Documentation

CreateNtuple()

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

protected

Definition at line 88 of file G4NtupleBookingManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "ntuple booking", name);
#endif
 
  // 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);
 
  // Create ntuple
  fLockFirstId = true;
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << index + fFirstId;
    fState.GetVerboseL2()->Message("create", "ntuple booking", description);
  } 
#endif
 
  return G4int(index + fFirstId);
}                                         

CreateNtupleDColumn() [1/2]

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

protected

Definition at line 134 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 167 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 127 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 160 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 120 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 153 of file G4NtupleBookingManager.cc.

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

CreateNtupleSColumn() [1/2]

G4int G4NtupleBookingManager::CreateNtupleSColumn ( const G4String &  name )

protected

Definition at line 141 of file G4NtupleBookingManager.cc.

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

Referenced by CreateNtupleSColumn().

CreateNtupleSColumn() [2/2]

G4int G4NtupleBookingManager::CreateNtupleSColumn ( G4int  ntupleId, const G4String &  name  )

protected

Definition at line 174 of file G4NtupleBookingManager.cc.

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

FinishNtuple() [1/2]

G4NtupleBooking * G4NtupleBookingManager::FinishNtuple ( )

protected

Definition at line 147 of file G4NtupleBookingManager.cc.

{
  return FinishNtuple(GetCurrentNtupleId());
}

Referenced by FinishNtuple().

FinishNtuple() [2/2]

G4NtupleBooking * G4NtupleBookingManager::FinishNtuple ( G4int  ntupleId )

protected

Definition at line 181 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 225 of file G4NtupleBookingManager.cc.

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

GetFileName()

G4String G4NtupleBookingManager::GetFileName ( G4int  id ) const

protected

Definition at line 283 of file G4NtupleBookingManager.cc.

{
  auto ntupleBooking
    = GetNtupleBookingInFunction(ntupleId, "GetFileName");
  if ( ! ntupleBooking ) 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 82 of file G4NtupleBookingManager.cc.

{
  return ! fNtupleBookingVector.size();
}  

SetActivation() [1/2]

void G4NtupleBookingManager::SetActivation ( G4bool  activation )

protected

Definition at line 205 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 214 of file G4NtupleBookingManager.cc.

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

SetFileName() [1/2]

void G4NtupleBookingManager::SetFileName ( const G4String &  fileName )

protected

Definition at line 236 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 245 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 ) {
      G4ExceptionDescription description;
      description
        << "The file extension " << extension << "is not supported.";
      G4Exception("G4NtupleBookingManager::SetFileName",
                  "Analysis_W051", JustWarning, description);
      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;
}

SetFileType()

void G4NtupleBookingManager::SetFileType

(

const G4String &

fileType

)

Definition at line 298 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()) {
    G4ExceptionDescription description;
      description
        << "Writing ntuples in files of different output types "
        << fFileType << ", " << extension << " is not supported." << G4endl
        << "Ntuple " << ntupleBooking->fNtupleBooking.name()
        << " will be written in " << ntupleFileName;
      G4Exception("G4NtupleBookingManager::SetFileType",
                  "Analysis_W051", JustWarning, description);
    }
 
    // Save the info in ntuple description
    ntupleBooking->fFileName = ntupleFileName;
  }
}

SetFirstNtupleColumnId()

G4bool G4NtupleBookingManager::SetFirstNtupleColumnId ( G4int  firstId )

protected

Definition at line 189 of file G4NtupleBookingManager.cc.

{ 
  if ( fLockFirstNtupleColumnId ) {
    G4ExceptionDescription description;
    description 
      << "Cannot set FirstNtupleColumnId as its value was already used.";
    G4Exception("G4BaseNtupleManager::SetFirstNtupleColumnId()",
                "Analysis_W013", JustWarning, description);
    return false;
  }              
 
  fFirstNtupleColumnId = firstId; 
  return true;
}

Friends And Related Function Documentation

G4VAnalysisManager

friend class G4VAnalysisManager

friend

Definition at line 59 of file G4NtupleBookingManager.hh.

Member Data Documentation

fNtupleBookingVector

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

protected

Definition at line 121 of file G4NtupleBookingManager.hh.

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

---

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

• G4NtupleBookingManager.hh
• G4NtupleBookingManager.cc