Geant4  10.02.p01
G4VP1Manager.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 P1 manager.
29 //
30 // Author: Ivana Hrivnacova, 24/07/2014 (ivana@ipno.in2p3.fr)
31 
32 #ifndef G4VP1Manager_h
33 #define G4VP1Manager_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
45  friend class G4VAnalysisManager;
46  friend class G4VAnalysisReader;
47 
48  public:
50  virtual ~G4VP1Manager() {}
51 
52  // deleted copy constructor & assignment operator
53  G4VP1Manager(const G4VP1Manager& rhs) = delete;
54  G4VP1Manager& operator=(const G4VP1Manager& rhs) = delete;
55 
56  protected:
57  // Methods for handling profiles
58  virtual G4int CreateP1(const G4String& name, const G4String& title,
59  G4int nbins, G4double xmin, G4double xmax,
60  G4double ymin = 0, G4double ymax = 0,
61  const G4String& xunitName = "none",
62  const G4String& yunitName = "none",
63  const G4String& xfcnName = "none",
64  const G4String& yfcnName = "none",
65  const G4String& xbinScheme = "linear") = 0;
66  virtual G4int CreateP1(const G4String& name, const G4String& title,
67  const std::vector<G4double>& edges,
68  G4double ymin = 0, G4double ymax = 0,
69  const G4String& xunitName = "none",
70  const G4String& yunitName = "none",
71  const G4String& xfcnName = "none",
72  const G4String& yfcnName = "none") = 0;
73 
74  virtual G4bool SetP1(G4int id,
75  G4int nbins, G4double xmin, G4double xmax,
76  G4double ymin = 0, G4double ymax = 0,
77  const G4String& xunitName = "none",
78  const G4String& yunitName = "none",
79  const G4String& xfcnName = "none",
80  const G4String& yfcnName = "none",
81  const G4String& xbinScheme = "linear") = 0;
82  virtual G4bool SetP1(G4int id,
83  const std::vector<G4double>& edges,
84  G4double ymin = 0, G4double ymax = 0,
85  const G4String& xunitName = "none",
86  const G4String& yunitName = "none",
87  const G4String& xfcnName = "none",
88  const G4String& yfcnName = "none") = 0;
89 
90  virtual G4bool ScaleP1(G4int id, G4double factor) = 0;
91 
92  // Methods to fill profiles
93  virtual G4bool FillP1(G4int id, G4double xvalue, G4double yvalue,
94  G4double weight = 1.0) = 0;
95 
96  // Access methods
97  virtual G4int GetP1Id(const G4String& name, G4bool warn = true) const = 0;
98 
99  // Access to P1 parameters
100  virtual G4int GetP1Nbins(G4int id) const = 0;
101  virtual G4double GetP1Xmin(G4int id) const = 0;
102  virtual G4double GetP1Xmax(G4int id) const = 0;
103  virtual G4double GetP1XWidth(G4int id) const = 0;
104  virtual G4double GetP1Ymin(G4int id) const = 0;
105  virtual G4double GetP1Ymax(G4int id) const = 0;
106 
107  // Setters for attributes for plotting
108  virtual G4bool SetP1Title(G4int id, const G4String& title) = 0;
109  virtual G4bool SetP1XAxisTitle(G4int id, const G4String& title) = 0;
110  virtual G4bool SetP1YAxisTitle(G4int id, const G4String& title) = 0;
111 
112  // Access attributes for plotting
113  virtual G4String GetP1Title(G4int id) const = 0;
114  virtual G4String GetP1XAxisTitle(G4int id) const = 0;
115  virtual G4String GetP1YAxisTitle(G4int id) const = 0;
116 
117  // Methods to manipulate profiles
118  // virtual G4bool WriteOnAscii(std::ofstream& output) = 0;
119 
120  // Access to Hn manager
121  virtual std::shared_ptr<G4HnManager> GetHnManager() = 0;
122 };
123 
124 #endif
125 
virtual G4int GetP1Nbins(G4int id) const =0
virtual G4bool SetP1XAxisTitle(G4int id, const G4String &title)=0
G4String name
Definition: TRTMaterials.hh:40
int G4int
Definition: G4Types.hh:78
virtual G4String GetP1Title(G4int id) const =0
virtual G4bool SetP1Title(G4int id, const G4String &title)=0
virtual G4String GetP1XAxisTitle(G4int id) const =0
virtual std::shared_ptr< G4HnManager > GetHnManager()=0
virtual G4bool SetP1YAxisTitle(G4int id, const G4String &title)=0
bool G4bool
Definition: G4Types.hh:79
virtual G4double GetP1Xmin(G4int id) const =0
virtual G4bool ScaleP1(G4int id, G4double factor)=0
virtual G4double GetP1Ymax(G4int id) const =0
G4VP1Manager & operator=(const G4VP1Manager &rhs)=delete
static const G4double factor
virtual G4double GetP1Ymin(G4int id) const =0
virtual G4int CreateP1(const G4String &name, const G4String &title, G4int nbins, G4double xmin, G4double xmax, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear")=0
virtual ~G4VP1Manager()
Definition: G4VP1Manager.hh:50
virtual G4bool FillP1(G4int id, G4double xvalue, G4double yvalue, G4double weight=1.0)=0
double G4double
Definition: G4Types.hh:76
virtual G4bool SetP1(G4int id, G4int nbins, G4double xmin, G4double xmax, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear")=0
virtual G4String GetP1YAxisTitle(G4int id) const =0
virtual G4double GetP1XWidth(G4int id) const =0
virtual G4double GetP1Xmax(G4int id) const =0
virtual G4int GetP1Id(const G4String &name, G4bool warn=true) const =0