| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26
27 // Manager class for CSV ntuples.
28 //
29 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4CsvNtupleManager_h
32 #define G4CsvNtupleManager_h 1
33
34 #include "G4TNtupleManager.hh"
35 #include "globals.hh"
36
37 #include "tools/wcsv_ntuple"
38
39 #include <memory>
40 #include <string_view>
41 #include <utility>
42
43 // Types alias
44 using CsvNtupleDescription = G4TNtupleDescription<tools::wcsv::ntuple, std::ofstream>;
45
46 class G4CsvFileManager;
47
48 class G4CsvNtupleManager : public G4TNtupleManager<tools::wcsv::ntuple,
49 std::ofstream>
50 {
51 friend class G4CsvAnalysisManager;
52 friend class G4CsvNtupleFileManager;
53
54 public:
55 explicit G4CsvNtupleManager(const G4AnalysisManagerState& state);
56 G4CsvNtupleManager() = delete;
57 ~G4CsvNtupleManager() override = default;
58
59 private:
60 // Functions specific to the output type
61
62 // Set methods
63 void SetFileManager(std::shared_ptr<G4CsvFileManager> fileManager);
64
65 // Access to ntuple vector (needed for Write())
66 const std::vector<CsvNtupleDescription*>& GetNtupleDescriptionVector() const;
67
68 void SetIsCommentedHeader(G4bool isCommentedHeader);
69 void SetIsHippoHeader(G4bool isHippoHeader);
70
71 // Methods from the templated base class
72 //
73 void CreateTNtupleFromBooking(CsvNtupleDescription* ntupleDescription) final;
74
75 void FinishTNtuple(CsvNtupleDescription* ntupleDescription, G4bool fromBooking) final;
76
77 G4bool WriteHeader(tools::wcsv::ntuple* ntuple) const;
78
79 // Static data members
80 static constexpr std::string_view fkClass { "G4CsvNtupleManager" };
81
82 // data members
83 std::shared_ptr<G4CsvFileManager> fFileManager { nullptr };
84 G4bool fIsCommentedHeader { true };
85 G4bool fIsHippoHeader { false };
86 };
87
88 // inline functions
89
90 inline void
91 G4CsvNtupleManager::SetFileManager(std::shared_ptr<G4CsvFileManager> fileManager)
92 {
93 fFileManager = std::move(fileManager);
94 }
95
96 inline const std::vector<G4TNtupleDescription<tools::wcsv::ntuple, std::ofstream>*>&
97 G4CsvNtupleManager::GetNtupleDescriptionVector() const
98 { return fNtupleDescriptionVector; }
99
100 inline void G4CsvNtupleManager::SetIsCommentedHeader(G4bool isCommentedHeader)
101 { fIsCommentedHeader = isCommentedHeader; }
102
103 inline void G4CsvNtupleManager::SetIsHippoHeader(G4bool isHippoHeader)
104 { fIsHippoHeader = isHippoHeader; }
105
106 #endif
107