include/Geant4/G4CsvAnalysisManager.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 Csv 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 G4CsvAnalysisManager_h
0033 #define G4CsvAnalysisManager_h 1
0034
0035 #include "G4ToolsAnalysisManager.hh"
0036 #include "globals.hh"
0037
0038 #include "tools/wcsv_ntuple"
0039
0040 #include <memory>
0041 #include <string_view>
0042
0043 class G4CsvAnalysisManager;
0044 class G4CsvNtupleFileManager;
0045 template <class T>
0046 class G4ThreadLocalSingleton;
0047
0048 class G4CsvAnalysisManager : public G4ToolsAnalysisManager
0049 {
0050   friend class G4ThreadLocalSingleton<G4CsvAnalysisManager>;
0051
0052   public:
0053     ~G4CsvAnalysisManager() override;
0054
0055     // Static methods
0056     static G4CsvAnalysisManager* Instance();
0057     static G4bool IsInstance();
0058
0059     // Access methods
0060     tools::wcsv::ntuple* GetNtuple() const;
0061     tools::wcsv::ntuple* GetNtuple(G4int ntupleId) const;
0062
0063     // Iterators
0064     std::vector<tools::wcsv::ntuple*>::iterator BeginNtuple();
0065     std::vector<tools::wcsv::ntuple*>::iterator EndNtuple();
0066     std::vector<tools::wcsv::ntuple*>::const_iterator BeginConstNtuple() const;
0067     std::vector<tools::wcsv::ntuple*>::const_iterator EndConstNtuple() const;
0068
0069     // Csv format specific option
0070     void SetIsCommentedHeader(G4bool isCommentedHeader);
0071     void SetIsHippoHeader(G4bool isHippoHeader);
0072
0073   private:
0074     G4CsvAnalysisManager();
0075
0076     // Static data members
0077     inline static G4ThreadLocal G4bool fgIsInstance { false };
0078     static constexpr std::string_view fkClass { "G4CsvAnalysisManager" };
0079
0080     // Data members
0081     std::shared_ptr<G4CsvNtupleFileManager> fNtupleFileManager { nullptr };
0082 };
0083
0084 #include "G4CsvAnalysisManager.icc"
0085
0086 #endif