include/Geant4/G4GenericAnalysisManager.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026
0027 // The main manager for Root analysis.
0028 // It delegates most of functions to the object specific managers.
0029
0030 // Author: Ivana Hrivnacova, 18/06/2013  (ivana@ipno.in2p3.fr)
0031
0032 #ifndef G4GenericAnalysisManager_h
0033 #define G4GenericAnalysisManager_h 1
0034
0035 #include "G4ToolsAnalysisManager.hh"
0036 #include "G4THnManager.hh"
0037 #include "G4AnalysisUtilities.hh"
0038 #include "globals.hh"
0039
0040 #include <memory>
0041 #include <string_view>
0042 #include <vector>
0043
0044 class G4GenericAnalysisManager;
0045 class G4GenericFileManager;
0046 class G4HnInformation;
0047 class G4VNtupleFileManager;
0048 template <class T>
0049 class G4ThreadLocalSingleton;
0050
0051 namespace tools {
0052 class ntuple_bookig;
0053 }
0054
0055 class G4GenericAnalysisManager : public  G4ToolsAnalysisManager
0056 {
0057   friend class G4RootMpiAnalysisManager;
0058   friend class G4ThreadLocalSingleton<G4GenericAnalysisManager>;
0059
0060   public:
0061     ~G4GenericAnalysisManager() override;
0062
0063     // Static methods
0064     static G4GenericAnalysisManager* Instance();
0065     static G4bool IsInstance();
0066
0067     // MT/MPI
0068     void SetNtupleMerging(G4bool mergeNtuples, G4int nofReducedNtupleFiles = 0) override;
0069     void SetNtupleRowWise(G4bool rowWise, G4bool rowMode = true) override;
0070     void SetBasketSize(unsigned int basketSize) override;
0071     void SetBasketEntries(unsigned int basketEntries) override;
0072
0073     // write in an extra file
0074     G4bool WriteH1(G4int id, const G4String& fileName);
0075     G4bool WriteH2(G4int id, const G4String& fileName);
0076     G4bool WriteH3(G4int id, const G4String& fileName);
0077     G4bool WriteP1(G4int id, const G4String& fileName);
0078     G4bool WriteP2(G4int id, const G4String& fileName);
0079
0080
0081     // Access methods
0082     // In difference from output specific managers, generic manager
0083     // provides access only to ntuple_booking
0084     tools::ntuple_booking* GetNtuple(G4bool warn = true,
0085                               G4bool onlyIfActive = true) const;
0086     tools::ntuple_booking* GetNtuple(G4int ntupleId, G4bool warn = true,
0087                               G4bool onlyIfActive = true) const;
0088
0089   protected:
0090     // Virtual methods from base class
0091     G4bool OpenFileImpl(const G4String& fileName) override;
0092     void SetDefaultFileTypeImpl(const G4String& value) override;
0093     G4String GetDefaultFileTypeImpl() const override;
0094     // File manager access
0095     std::shared_ptr<G4VFileManager> GetFileManager(const G4String& fileName) final;
0096
0097   private:
0098     G4GenericAnalysisManager();
0099     // Methods
0100     void CreateNtupleFileManager(const G4String& fileName);
0101
0102     // Static data members
0103     inline static G4GenericAnalysisManager* fgMasterInstance { nullptr };
0104     inline static G4ThreadLocal G4bool fgIsInstance { false };
0105     static constexpr std::string_view fkClass { "G4GenericAnalysisManager" };
0106
0107     // Data members
0108     std::shared_ptr<G4GenericFileManager> fFileManager { nullptr };
0109     // add G4GenericNtupleManager
0110     // this class will be analogic to file managers but with ntuples
0111     std::shared_ptr<G4VNtupleFileManager> fNtupleFileManager { nullptr };
0112
0113     // Data members
0114     G4bool  fIsNtupleMergingSet { false };
0115     G4int   fNofNtupleFiles { 0 };
0116     G4bool  fMergeNtuples { false };
0117     G4bool  fNtupleRowWise { false };
0118     G4bool  fNtupleRowMode { true };
0119     unsigned int fBasketSize { G4Analysis::kDefaultBasketSize };
0120     unsigned int fBasketEntries { G4Analysis::kDefaultBasketEntries };
0121 };
0122
0123 #include "G4GenericAnalysisManager.icc"
0124
0125 #endif