Geant4  10.02
G4CsvNtupleManager.hh
Go to the documentation of this file.
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 // $Id: G4CsvNtupleManager.hh 70604 2013-06-03 11:27:06Z ihrivnac $
27 
28 // Manager class for CSV ntuples.
29 //
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31 
32 #ifndef G4CsvNtupleManager_h
33 #define G4CsvNtupleManager_h 1
34 
35 #include "G4TNtupleManager.hh"
36 #include "globals.hh"
37 
38 #include "tools/wcsv_ntuple"
39 
40 #include <memory>
41 
42 class G4CsvFileManager;
43 
44 class G4CsvNtupleManager : public G4TNtupleManager<tools::wcsv::ntuple>
45 {
46  friend class G4CsvAnalysisManager;
47 
48  public:
49  explicit G4CsvNtupleManager(const G4AnalysisManagerState& state);
51 
52  private:
53  // Types alias
54  using NtupleType = tools::wcsv::ntuple;
56 
57  // Functions specific to the output type
58 
59  // Set methods
60  void SetFileManager(std::shared_ptr<G4CsvFileManager> fileManager);
61 
62  // Access to ntuple vector (needed for Write())
63  const std::vector<NtupleDescriptionType*>& GetNtupleDescriptionVector() const;
64 
65  void SetIsCommentedHeader(G4bool isCommentedHeader);
66  void SetIsHippoHeader(G4bool isHippoHeader);
67 
68  // Methods from the templated base class
69  //
70  virtual void CreateTNtuple(
71  NtupleDescriptionType* ntupleDescription,
72  const G4String& name, const G4String& title) final;
73  virtual void CreateTNtupleFromBooking(
74  NtupleDescriptionType* ntupleDescription) final;
75 
76  virtual void FinishTNtuple(
77  NtupleDescriptionType* ntupleDescription) final;
78 
79  G4bool WriteHeader(NtupleType* ntuple) const;
80 
81  // data members
82  std::shared_ptr<G4CsvFileManager> fFileManager;
85 };
86 
87 // inline functions
88 
89 inline void
90 G4CsvNtupleManager::SetFileManager(std::shared_ptr<G4CsvFileManager> fileManager)
91 { fFileManager = fileManager; }
92 
93 inline const std::vector<G4TNtupleDescription<tools::wcsv::ntuple>*>&
95 { return fNtupleDescriptionVector; }
96 
97 inline void G4CsvNtupleManager::SetIsCommentedHeader(G4bool isCommentedHeader)
98 { fIsCommentedHeader = isCommentedHeader; }
99 
101 { fIsHippoHeader = isHippoHeader; }
102 
103 #endif
104 
G4String name
Definition: TRTMaterials.hh:40
G4CsvNtupleManager(const G4AnalysisManagerState &state)
virtual void FinishTNtuple(NtupleDescriptionType *ntupleDescription) final
std::vector< G4TNtupleDescription< tools::wcsv::ntuple > * > fNtupleDescriptionVector
std::shared_ptr< G4CsvFileManager > fFileManager
void SetFileManager(std::shared_ptr< G4CsvFileManager > fileManager)
bool G4bool
Definition: G4Types.hh:79
virtual void CreateTNtupleFromBooking(NtupleDescriptionType *ntupleDescription) final
const std::vector< NtupleDescriptionType * > & GetNtupleDescriptionVector() const
void SetIsHippoHeader(G4bool isHippoHeader)
tools::wcsv::ntuple NtupleType
virtual void CreateTNtuple(NtupleDescriptionType *ntupleDescription, const G4String &name, const G4String &title) final
void SetIsCommentedHeader(G4bool isCommentedHeader)
G4bool WriteHeader(NtupleType *ntuple) const