Geant4  10.00.p03
G4RootNtupleManager.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: G4RootNtupleManager.hh 70604 2013-06-03 11:27:06Z ihrivnac $
27 
28 // Manager class for Root ntuples.
29 // It implements functions specific to Root ntuples.
30 //
31 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
32 
33 #ifndef G4RootNtupleManager_h
34 #define G4RootNtupleManager_h 1
35 
36 #include "G4VNtupleManager.hh"
37 #include "globals.hh"
38 
39 #include "tools/wroot/ntuple"
40 
41 #include <vector>
42 
44 
45 namespace tools {
46 namespace wroot {
47 class directory;
48 }
49 }
50 
52 {
53  friend class G4RootAnalysisManager;
54 
55  protected:
57  virtual ~G4RootNtupleManager();
58 
59  // Functions specific to the output type
60  //
61 
62  // Methods to manipulate ntuples
64  G4bool IsEmpty() const;
65  G4bool Reset();
66 
67  // Set methods
68  void SetNtupleDirectory(tools::wroot::directory* directory);
69 
70  // Access methods
71  tools::wroot::ntuple* GetNtuple() const;
72  tools::wroot::ntuple* GetNtuple(G4int ntupleId) const;
73 
74  // Functions independent from the output type
75  //
76 
77  // Methods to create ntuples
78  virtual G4int CreateNtuple(const G4String& name, const G4String& title);
79  // Create columns in the last created ntuple
80  virtual G4int CreateNtupleIColumn(const G4String& name);
81  virtual G4int CreateNtupleFColumn(const G4String& name);
82  virtual G4int CreateNtupleDColumn(const G4String& name);
83  virtual void FinishNtuple();
84  // Create columns in the ntuple with given id
85  virtual G4int CreateNtupleIColumn(G4int ntupleId, const G4String& name);
86  virtual G4int CreateNtupleFColumn(G4int ntupleId, const G4String& name);
87  virtual G4int CreateNtupleDColumn(G4int ntupleId, const G4String& name);
88  virtual void FinishNtuple(G4int ntupleId);
89 
90  // Methods to fill ntuples
91  // Methods for ntuple with id = FirstNtupleId
92  virtual G4bool FillNtupleIColumn(G4int columnId, G4int value);
93  virtual G4bool FillNtupleFColumn(G4int columnId, G4float value);
94  virtual G4bool FillNtupleDColumn(G4int columnId, G4double value);
95  virtual G4bool AddNtupleRow();
96  // Methods for ntuple with id > FirstNtupleId (when more ntuples exist)
97  virtual G4bool FillNtupleIColumn(G4int ntupleId, G4int columnId, G4int value);
98  virtual G4bool FillNtupleFColumn(G4int ntupleId, G4int columnId, G4float value);
99  virtual G4bool FillNtupleDColumn(G4int ntupleId, G4int columnId, G4double value);
100  virtual G4bool AddNtupleRow(G4int ntupleId);
101 
102  // Access methods
103  virtual G4int GetNofNtuples() const;
104 
105  private:
106  // methods
107  //
108  tools::wroot::ntuple::column<int>*
109  GetNtupleIColumn(G4int ntupleId, G4int columnId) const;
110  tools::wroot::ntuple::column<float>*
111  GetNtupleFColumn(G4int ntupleId, G4int columnId) const;
112  tools::wroot::ntuple::column<double>*
113  GetNtupleDColumn(G4int ntupleId, G4int columnId) const;
114 
116  G4String function,
117  G4bool warn = true,
118  G4bool onlyIfActive = true) const;
119 
120  // data members
121  //
122  tools::wroot::directory* fNtupleDirectory;
123  std::vector<G4RootNtupleDescription*> fNtupleVector;
124 };
125 
126 // inline functions
127 
129  tools::wroot::directory* directory) {
130  fNtupleDirectory = directory;
131 }
132 
134 { return fNtupleVector.size(); }
135 
136 
137 #endif
138 
tools::wroot::ntuple::column< int > * GetNtupleIColumn(G4int ntupleId, G4int columnId) const
virtual G4bool FillNtupleFColumn(G4int columnId, G4float value)
virtual G4int CreateNtupleFColumn(const G4String &name)
G4String name
Definition: TRTMaterials.hh:40
float G4float
Definition: G4Types.hh:77
tools::wroot::directory * fNtupleDirectory
virtual G4int CreateNtupleDColumn(const G4String &name)
tools::wroot::ntuple::column< float > * GetNtupleFColumn(G4int ntupleId, G4int columnId) const
int G4int
Definition: G4Types.hh:78
virtual G4bool FillNtupleIColumn(G4int columnId, G4int value)
bool G4bool
Definition: G4Types.hh:79
std::vector< G4RootNtupleDescription * > fNtupleVector
virtual G4RootNtupleDescription * GetNtupleInFunction(G4int id, G4String function, G4bool warn=true, G4bool onlyIfActive=true) const
tools::wroot::ntuple * GetNtuple() const
virtual G4int CreateNtupleIColumn(const G4String &name)
virtual G4int GetNofNtuples() const
virtual G4bool AddNtupleRow()
tools::wroot::ntuple::column< double > * GetNtupleDColumn(G4int ntupleId, G4int columnId) const
virtual G4int CreateNtuple(const G4String &name, const G4String &title)
double G4double
Definition: G4Types.hh:76
G4RootNtupleManager(const G4AnalysisManagerState &state)
virtual G4bool FillNtupleDColumn(G4int columnId, G4double value)
void SetNtupleDirectory(tools::wroot::directory *directory)