Geant4  10.02.p01
G4VP2Manager.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$
27 
28 // Base class for P2 manager.
29 //
30 // Author: Ivana Hrivnacova, 24/07/2014 (ivana@ipno.in2p3.fr)
31 
32 #ifndef G4VP2Manager_h
33 #define G4VP2Manager_h 1
34 
35 #include "globals.hh"
36 
37 #include <vector>
38 #include <memory>
39 
40 class G4HnManager;
41 
43 {
44  // Disable using the object managers outside G4VAnalysisManager
45  friend class G4VAnalysisManager;
46  friend class G4VAnalysisReader;
47 
48  public:
50  virtual ~G4VP2Manager() {}
51 
52  // deleted copy constructor & assignment operator
53  G4VP2Manager(const G4VP2Manager& rhs) = delete;
54  G4VP2Manager& operator=(const G4VP2Manager& rhs) = delete;
55 
56  protected:
57  // Methods for handling histograms
58  virtual G4int CreateP2(const G4String& name, const G4String& title,
59  G4int nxbins, G4double xmin, G4double xmax,
60  G4int nybins, G4double ymin, G4double ymax,
61  G4double zmin = 0, G4double zmax = 0,
62  const G4String& xunitName = "none",
63  const G4String& yunitName = "none",
64  const G4String& zunitName = "none",
65  const G4String& xfcnName = "none",
66  const G4String& yfcnName = "none",
67  const G4String& zfcnName = "none",
68  const G4String& xbinScheme = "linear",
69  const G4String& ybinScheme = "linear") = 0;
70 
71  virtual G4int CreateP2(const G4String& name, const G4String& title,
72  const std::vector<G4double>& xedges,
73  const std::vector<G4double>& yedges,
74  G4double zmin = 0, G4double zmax = 0,
75  const G4String& xunitName = "none",
76  const G4String& yunitName = "none",
77  const G4String& zunitName = "none",
78  const G4String& xfcnName = "none",
79  const G4String& yfcnName = "none",
80  const G4String& zfcnName = "none") = 0;
81 
82  virtual G4bool SetP2(G4int id,
83  G4int nxbins, G4double xmin, G4double xmax,
84  G4int nybins, G4double ymin, G4double ymax,
85  G4double zmin = 0, G4double zmax = 0,
86  const G4String& xunitName = "none",
87  const G4String& yunitName = "none",
88  const G4String& zunitName = "none",
89  const G4String& xfcnName = "none",
90  const G4String& yfcnName = "none",
91  const G4String& zfcnName = "none",
92  const G4String& xbinScheme = "linear",
93  const G4String& ybinScheme = "linear") = 0;
94 
95  virtual G4bool SetP2(G4int id,
96  const std::vector<G4double>& xedges,
97  const std::vector<G4double>& yedges,
98  G4double zmin = 0, G4double zmax = 0,
99  const G4String& xunitName = "none",
100  const G4String& yunitName = "none",
101  const G4String& zunitName = "none",
102  const G4String& xfcnName = "none",
103  const G4String& yfcnName = "none",
104  const G4String& zfcnName = "none") = 0;
105 
106  virtual G4bool ScaleP2(G4int id, G4double factor) = 0;
107 
108  // Methods to fill histograms
109  virtual G4bool FillP2(G4int id,
110  G4double xvalue, G4double yvalue, G4double zvalue,
111  G4double weight = 1.0) = 0;
112 
113  // Access methods
114  virtual G4int GetP2Id(const G4String& name, G4bool warn = true) const = 0;
115 
116  // Access to P2 parameters
117  virtual G4int GetP2Nxbins(G4int id) const = 0;
118  virtual G4double GetP2Xmin(G4int id) const = 0;
119  virtual G4double GetP2Xmax(G4int id) const = 0;
120  virtual G4double GetP2XWidth(G4int id) const = 0;
121  virtual G4int GetP2Nybins(G4int id) const = 0;
122  virtual G4double GetP2Ymin(G4int id) const = 0;
123  virtual G4double GetP2Ymax(G4int id) const = 0;
124  virtual G4double GetP2YWidth(G4int id) const = 0;
125  virtual G4double GetP2Zmin(G4int id) const = 0;
126  virtual G4double GetP2Zmax(G4int id) const = 0;
127 
128  // Setters for attributes for plotting
129  virtual G4bool SetP2Title(G4int id, const G4String& title) = 0;
130  virtual G4bool SetP2XAxisTitle(G4int id, const G4String& title) = 0;
131  virtual G4bool SetP2YAxisTitle(G4int id, const G4String& title) = 0;
132  virtual G4bool SetP2ZAxisTitle(G4int id, const G4String& title) = 0;
133 
134  // Access attributes for plotting
135  virtual G4String GetP2Title(G4int id) const = 0;
136  virtual G4String GetP2XAxisTitle(G4int id) const = 0;
137  virtual G4String GetP2YAxisTitle(G4int id) const = 0;
138  virtual G4String GetP2ZAxisTitle(G4int id) const = 0;
139 
140  // Methods to manipulate histograms
141  virtual G4bool WriteOnAscii(std::ofstream& output) = 0;
142 
143  // Access to Hn manager
144  virtual std::shared_ptr<G4HnManager> GetHnManager() = 0;
145 };
146 
147 #endif
148 
virtual ~G4VP2Manager()
Definition: G4VP2Manager.hh:50
virtual G4String GetP2ZAxisTitle(G4int id) const =0
virtual G4double GetP2Xmin(G4int id) const =0
virtual G4double GetP2Xmax(G4int id) const =0
virtual G4int GetP2Nxbins(G4int id) const =0
virtual G4double GetP2Ymax(G4int id) const =0
virtual G4int GetP2Nybins(G4int id) const =0
G4String name
Definition: TRTMaterials.hh:40
virtual G4bool SetP2Title(G4int id, const G4String &title)=0
virtual G4String GetP2XAxisTitle(G4int id) const =0
virtual G4double GetP2Ymin(G4int id) const =0
virtual G4bool SetP2ZAxisTitle(G4int id, const G4String &title)=0
int G4int
Definition: G4Types.hh:78
virtual G4int CreateP2(const G4String &name, const G4String &title, G4int nxbins, G4double xmin, G4double xmax, G4int nybins, G4double ymin, G4double ymax, G4double zmin=0, G4double zmax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &zunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &zfcnName="none", const G4String &xbinScheme="linear", const G4String &ybinScheme="linear")=0
virtual G4bool SetP2(G4int id, G4int nxbins, G4double xmin, G4double xmax, G4int nybins, G4double ymin, G4double ymax, G4double zmin=0, G4double zmax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &zunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &zfcnName="none", const G4String &xbinScheme="linear", const G4String &ybinScheme="linear")=0
virtual G4bool SetP2XAxisTitle(G4int id, const G4String &title)=0
bool G4bool
Definition: G4Types.hh:79
G4VP2Manager & operator=(const G4VP2Manager &rhs)=delete
virtual G4double GetP2XWidth(G4int id) const =0
virtual G4double GetP2YWidth(G4int id) const =0
virtual G4bool FillP2(G4int id, G4double xvalue, G4double yvalue, G4double zvalue, G4double weight=1.0)=0
virtual std::shared_ptr< G4HnManager > GetHnManager()=0
virtual G4String GetP2YAxisTitle(G4int id) const =0
virtual G4String GetP2Title(G4int id) const =0
virtual G4double GetP2Zmax(G4int id) const =0
virtual G4bool SetP2YAxisTitle(G4int id, const G4String &title)=0
virtual G4bool ScaleP2(G4int id, G4double factor)=0
static const G4double factor
virtual G4double GetP2Zmin(G4int id) const =0
virtual G4bool WriteOnAscii(std::ofstream &output)=0
double G4double
Definition: G4Types.hh:76
virtual G4int GetP2Id(const G4String &name, G4bool warn=true) const =0