| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4StateManager 26 // G4StateManager
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // Class responsible for handling and updating 30 // Class responsible for handling and updating the running state
31 // of the Geant4 application during its differ 31 // of the Geant4 application during its different phases.
32 // The class is a singleton, it can be accesse 32 // The class is a singleton, it can be accessed via the public
33 // method G4StateManager::GetStateManager(). 33 // method G4StateManager::GetStateManager().
34 // 34 //
35 // States of Geant4 are defined in G4Applicati 35 // States of Geant4 are defined in G4ApplicationState.
36 36
37 // Authors: G.Cosmo, M.Asai - November 1996 37 // Authors: G.Cosmo, M.Asai - November 1996
38 // ------------------------------------------- 38 // --------------------------------------------------------------------
39 #ifndef G4StateManager_hh 39 #ifndef G4StateManager_hh
40 #define G4StateManager_hh 1 40 #define G4StateManager_hh 1
41 41
42 #include "G4ApplicationState.hh" 42 #include "G4ApplicationState.hh"
43 #include "G4String.hh" 43 #include "G4String.hh"
44 #include "G4Types.hh" 44 #include "G4Types.hh"
45 #include "G4VExceptionHandler.hh" 45 #include "G4VExceptionHandler.hh"
46 #include "G4VStateDependent.hh" 46 #include "G4VStateDependent.hh"
47 #include <vector> 47 #include <vector>
48 48
49 class G4Run; <<
50 class G4Event; <<
51 <<
52 class G4StateManager 49 class G4StateManager
53 { 50 {
54 public: 51 public:
55 static G4StateManager* GetStateManager(); 52 static G4StateManager* GetStateManager();
56 // The G4StateManager class is a singleton c 53 // The G4StateManager class is a singleton class and the pointer
57 // to the only one existing object can be ob 54 // to the only one existing object can be obtained by this static
58 // method. 55 // method.
59 56
60 ~G4StateManager(); 57 ~G4StateManager();
61 58
62 G4StateManager(const G4StateManager&) = dele 59 G4StateManager(const G4StateManager&) = delete;
63 G4StateManager& operator=(const G4StateManag 60 G4StateManager& operator=(const G4StateManager&) = delete;
64 G4bool operator==(const G4StateManager&) con 61 G4bool operator==(const G4StateManager&) const = delete;
65 G4bool operator!=(const G4StateManager&) con 62 G4bool operator!=(const G4StateManager&) const = delete;
66 63
67 const G4ApplicationState& GetCurrentState() 64 const G4ApplicationState& GetCurrentState() const;
68 // Returns the current state 65 // Returns the current state
69 const G4ApplicationState& GetPreviousState() 66 const G4ApplicationState& GetPreviousState() const;
70 // Returns the previous state 67 // Returns the previous state
71 G4bool SetNewState(const G4ApplicationState& 68 G4bool SetNewState(const G4ApplicationState& requestedState);
72 // Set Geant4 to a new state. 69 // Set Geant4 to a new state.
73 // In case the request is illegal, false wil 70 // In case the request is illegal, false will be returned
74 // and the state of Geant4 will not be chang 71 // and the state of Geant4 will not be changed
75 G4bool SetNewState(const G4ApplicationState& 72 G4bool SetNewState(const G4ApplicationState& requestedState, const char* msg);
76 // Set Geant4 to a new state. 73 // Set Geant4 to a new state.
77 // In case the request is illegal, false wil 74 // In case the request is illegal, false will be returned
78 // and the state of Geant4 will not be chang 75 // and the state of Geant4 will not be changed.
79 // "msg" is the information associated to th 76 // "msg" is the information associated to the state change
80 G4bool RegisterDependent(G4VStateDependent* 77 G4bool RegisterDependent(G4VStateDependent* aDependent,
81 G4bool bottom = fal 78 G4bool bottom = false);
82 // Register a concrete class of G4VStateDepe 79 // Register a concrete class of G4VStateDependent.
83 // Registered concrete classes will be notif 80 // Registered concrete classes will be notified via
84 // G4VStateDependent::Notify() method when t 81 // G4VStateDependent::Notify() method when the state of Geant4 changes.
85 // False will be returned if registration fa 82 // False will be returned if registration fails
86 G4bool DeregisterDependent(G4VStateDependent 83 G4bool DeregisterDependent(G4VStateDependent* aDependent);
87 // Remove the registration. 84 // Remove the registration.
88 // False will be returned if aDependent has 85 // False will be returned if aDependent has not been registered
89 G4VStateDependent* RemoveDependent(const G4V 86 G4VStateDependent* RemoveDependent(const G4VStateDependent* aDependent);
90 // Remove the registration. 87 // Remove the registration.
91 // Removed pointer is returned 88 // Removed pointer is returned
92 G4String GetStateString(const G4ApplicationS 89 G4String GetStateString(const G4ApplicationState& aState) const;
93 // Utility method which returns a string of 90 // Utility method which returns a string of the state name
94 <<
95 void NotifyDeletion(const G4Event*); <<
96 void NotifyDeletion(const G4Run*); <<
97 // Notifying when an event or a run is delet <<
98 // a state-dependent class from accessing to <<
99 91
100 inline void SetSuppressAbortion(G4int i); 92 inline void SetSuppressAbortion(G4int i);
101 inline G4int GetSuppressAbortion() const; 93 inline G4int GetSuppressAbortion() const;
102 inline const char* GetMessage() const; 94 inline const char* GetMessage() const;
103 inline void SetExceptionHandler(G4VException 95 inline void SetExceptionHandler(G4VExceptionHandler* eh);
104 inline G4VExceptionHandler* GetExceptionHand 96 inline G4VExceptionHandler* GetExceptionHandler() const;
105 static void SetVerboseLevel(G4int val); 97 static void SetVerboseLevel(G4int val);
106 98
107 private: 99 private:
108 G4StateManager(); 100 G4StateManager();
109 101
110 private: 102 private:
111 static G4ThreadLocal G4StateManager* theStat 103 static G4ThreadLocal G4StateManager* theStateManager;
112 G4ApplicationState theCurrentState = G4Stat 104 G4ApplicationState theCurrentState = G4State_PreInit;
113 G4ApplicationState thePreviousState = G4Stat 105 G4ApplicationState thePreviousState = G4State_PreInit;
114 std::vector<G4VStateDependent*> theDependent 106 std::vector<G4VStateDependent*> theDependentsList;
115 G4VStateDependent* theBottomDependent = null 107 G4VStateDependent* theBottomDependent = nullptr;
116 G4int suppressAbortion = 0; 108 G4int suppressAbortion = 0;
117 const char* msgptr = null 109 const char* msgptr = nullptr;
118 G4VExceptionHandler* exceptionHandler = null 110 G4VExceptionHandler* exceptionHandler = nullptr;
119 static G4int verboseLevel; 111 static G4int verboseLevel;
120 }; 112 };
121 113
122 #include "G4StateManager.icc" 114 #include "G4StateManager.icc"
123 115
124 #endif 116 #endif
125 117