| 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 // The state of the analysis manager instance.
28 //
29 // Author: Ivana Hrivnacova, 09/07/2013 (ivana@ipno.in2p3.fr)
30
31 #ifndef G4AnalysisManagerState_h
32 #define G4AnalysisManagerState_h 1
33
34 #include "G4AnalysisVerbose.hh"
35 #include "G4Threading.hh"
36 #include "globals.hh"
37
38 #include <string_view>
39
40 class G4AnalysisManagerState
41 {
42 // Only G4VAnalysisManager can change the state
43 friend class G4VAnalysisManager;
44 friend class G4VAnalysisReader;
45 friend class G4ParameterManager;
46
47 public:
48 G4AnalysisManagerState(G4String type, G4bool isMaster);
49 // disabled constructors, operators
50 G4AnalysisManagerState() = delete;
51 G4AnalysisManagerState(const G4AnalysisManagerState&) = delete;
52 G4AnalysisManagerState& operator=(const G4AnalysisManagerState&) = delete;
53
54 // Methods
55 void Message([[maybe_unused]] G4int level,
56 [[maybe_unused]] const G4String& action,
57 [[maybe_unused]] const G4String& objectType,
58 [[maybe_unused]] const G4String& objectName = "",
59 [[maybe_unused]] G4bool success = true) const;
60 void IncrementCycle();
61 void ResetCycle();
62
63 // get methods
64 G4String GetType() const;
65 G4String GetFileType() const;
66 G4bool GetIsMaster() const;
67 G4int GetThreadId() const;
68 G4bool GetIsActivation() const;
69 G4int GetVerboseLevel() const;
70 G4bool IsVerbose(G4int verboseLevel) const;
71 G4int GetCycle() const;
72
73 private:
74 // set methods
75 // (hidden from all clients except for G4VAnalysisManager friend)
76 void SetIsActivation(G4bool isActivation);
77 void SetVerboseLevel(G4int verboseLevel);
78
79 // Static data members
80 static constexpr std::string_view fkClass { "G4AnalysisManagerState" };
81
82 // Data members
83 G4String fType;
84 G4bool fIsMaster;
85 G4int fThreadId { G4Threading::SEQUENTIAL_ID };
86 G4bool fIsActivation { false };
87 G4int fVerboseLevel { 0 };
88 G4int fCycle { 0 };
89 G4AnalysisVerbose fVerbose;
90 };
91
92 // inline functions
93
94 inline void G4AnalysisManagerState::SetIsActivation(G4bool isActivation)
95 { fIsActivation = isActivation; }
96
97 inline void G4AnalysisManagerState::IncrementCycle()
98 { ++fCycle; }
99
100 inline void G4AnalysisManagerState::ResetCycle()
101 { fCycle = 0; }
102
103 inline G4String G4AnalysisManagerState::GetType() const
104 { return fType; }
105
106 inline G4String G4AnalysisManagerState::GetFileType() const
107 { return G4StrUtil::to_lower_copy(fType); }
108
109 inline G4bool G4AnalysisManagerState::GetIsMaster() const
110 { return fIsMaster; }
111
112 inline G4int G4AnalysisManagerState::GetThreadId() const
113 { return fThreadId; }
114
115 inline G4bool G4AnalysisManagerState::GetIsActivation() const
116 { return fIsActivation; }
117
118 inline G4int G4AnalysisManagerState::GetVerboseLevel() const
119 { return fVerboseLevel; }
120
121 inline G4bool G4AnalysisManagerState::IsVerbose(G4int verboseLevel) const
122 { return fVerboseLevel == verboseLevel; }
123
124 inline G4int G4AnalysisManagerState::GetCycle() const
125 { return fCycle; }
126
127 #endif
128