| 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 // Base class for the object managers.
28 // It handles first object ID and its lock and provides common utility methods.
29
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31
32 #ifndef G4BaseAnalysisManager_h
33 #define G4BaseAnalysisManager_h 1
34
35 #include "G4Fcn.hh"
36 #include "G4BinScheme.hh"
37 #include "globals.hh"
38
39 #include "G4AnalysisManagerState.hh"
40
41 #include <string_view>
42
43 class G4BaseAnalysisManager
44 {
45 public:
46 explicit G4BaseAnalysisManager(const G4AnalysisManagerState& state);
47 G4BaseAnalysisManager() = delete;
48 virtual ~G4BaseAnalysisManager() = default;
49
50 // The ids of objects are generated automatically
51 // starting from 0; with the following function it is possible to
52 // change the first Id to start from other value
53 G4bool SetFirstId(G4int firstId);
54 void SetLockFirstId(G4bool lockFirstId);
55
56 // Access method
57 G4int GetFirstId() const;
58 G4int GetCycle() const;
59
60 protected:
61 // Methods for verbose
62 G4bool IsVerbose(G4int verboseLevel) const;
63 void Message(G4int level,
64 const G4String& action,
65 const G4String& objectType,
66 const G4String& objectName = "",
67 G4bool success = true) const;
68
69 // Data members
70 const G4AnalysisManagerState& fState;
71 G4int fFirstId { 0 };
72 G4bool fLockFirstId { false };
73
74 private:
75 // Static data members
76 static constexpr std::string_view fkClass { "G4BaseAnalysisManager" };
77 };
78
79 // inline functions
80
81 inline G4bool G4BaseAnalysisManager::IsVerbose(G4int verboseLevel) const
82 { return fState.IsVerbose(verboseLevel); }
83
84 inline void G4BaseAnalysisManager::Message(
85 G4int level, const G4String& action, const G4String& objectType,
86 const G4String& objectName, G4bool success) const
87 {
88 fState.Message(level, action, objectType, objectName, success);
89 }
90
91 inline void G4BaseAnalysisManager::SetLockFirstId(G4bool lockFirstId) {
92 fLockFirstId = lockFirstId;
93 }
94
95 inline G4int G4BaseAnalysisManager::GetFirstId() const {
96 return fFirstId;
97 }
98
99 inline G4int G4BaseAnalysisManager::GetCycle() const {
100 return fState.GetCycle();
101 }
102
103 #endif
104
105