G4VNtupleFileManager.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
 
// The abstract base class for ntuple file output.
//
// Author: Ivana Hrivnacova, 15/09/2020  ([email protected])
 
#ifndef G4VNtupleFileManager_h
#define G4VNtupleFileManager_h 1
 
#include "G4AnalysisManagerState.hh"
#include "globals.hh"
 
#include <memory>
#include <string_view>
#include <utility>
 
class G4VNtupleManager;
class G4NtupleBookingManager;
 
enum class G4NtupleMergeMode {
  kNone,
  kMain,
  kSlave
};
 
class G4VNtupleFileManager
{
  // Disable using the object managers outside G4VAnalysisManager and
  // its messenger
  friend class G4VAnalysisManager;
 
  public:
    G4VNtupleFileManager(const G4AnalysisManagerState& state, G4String fileType);
    G4VNtupleFileManager() = delete;
    virtual ~G4VNtupleFileManager() = default;
 
    // deleted copy constructor & assignment operator
    G4VNtupleFileManager(const G4VNtupleFileManager& rhs) = delete;
    G4VNtupleFileManager& operator=(const G4VNtupleFileManager& rhs) = delete;
 
    // MT/MPI
    virtual void SetNtupleMerging(G4bool mergeNtuples,
                   G4int nofReducedNtupleFiles = 0);
    virtual void SetNtupleRowWise(G4bool rowWise, G4bool rowMode = true);
    virtual void SetBasketSize(unsigned int basketSize);
    virtual void SetBasketEntries(unsigned int basketEntries);
 
    virtual std::shared_ptr<G4VNtupleManager> CreateNtupleManager() = 0;
    virtual void SetBookingManager(std::shared_ptr<G4NtupleBookingManager> bookingManager);
 
    // Methods to be performed at file management
    virtual G4bool ActionAtOpenFile(const G4String& /*fileName*/) = 0;
    virtual G4bool ActionAtWrite() = 0;
    virtual G4bool ActionAtCloseFile() = 0;
    virtual G4bool Reset() = 0;
    virtual G4bool IsNtupleMergingSupported() const;
    virtual G4NtupleMergeMode GetMergeMode() const;
 
    // Get methods
    G4String GetFileType() const;
 
  protected:
    // Methods for verbose
    void Message(G4int level,
                 const G4String& action,
                 const G4String& objectType,
                 const G4String& objectName = "",
                 G4bool success = true) const;
 
    // Static data members
    const G4AnalysisManagerState& fState;
    G4String  fFileType;
    std::shared_ptr<G4NtupleBookingManager> fBookingManager { nullptr };
 
  private:
    // Static data members
    static constexpr std::string_view fkClass { "G4VNtupleFileManager" };
};
 
// inline functions
 
inline void G4VNtupleFileManager::SetBookingManager(
  std::shared_ptr<G4NtupleBookingManager> bookingManager)
{
  fBookingManager = std::move(bookingManager);
}
 
inline G4bool G4VNtupleFileManager::IsNtupleMergingSupported() const {
  return false;
}
 
inline G4String G4VNtupleFileManager::GetFileType() const {
  return fFileType;
}
 
inline void G4VNtupleFileManager::Message(
  G4int level, const G4String& action, const G4String& objectType,
  const G4String& objectName, G4bool success) const
{
  fState.Message(level, action, objectType, objectName, success);
}
 
inline G4NtupleMergeMode G4VNtupleFileManager::GetMergeMode() const {
  return G4NtupleMergeMode::kNone;
}
 
#endif