| Geant4 Cross Reference |
1 // 1
2 // *******************************************
3 // * License and Disclaimer
4 // *
5 // * The Geant4 software is copyright of th
6 // * the Geant4 Collaboration. It is provided
7 // * conditions of the Geant4 Software License
8 // * LICENSE and available at http://cern.ch/
9 // * include a list of copyright holders.
10 // *
11 // * Neither the authors of this software syst
12 // * institutes,nor the agencies providing fin
13 // * work make any representation or warran
14 // * regarding this software system or assum
15 // * use. Please see the license in the file
16 // * for the full disclaimer and the limitatio
17 // *
18 // * This code implementation is the result
19 // * technical work of the GEANT4 collaboratio
20 // * By using, copying, modifying or distri
21 // * any work based on the software) you ag
22 // * use in resulting scientific publicati
23 // * acceptance of all terms of the Geant4 Sof
24 // *******************************************
25 //
26 // G4GenericMessenger
27 //
28 // Class description:
29 //
30 // A generic messenger class.
31
32 // Author: P.Mato, CERN - 27 September 2012
33 // -------------------------------------------
34 #ifndef G4GenericMessenger_hh
35 #define G4GenericMessenger_hh 1
36
37 #include "G4AnyMethod.hh"
38 #include "G4AnyType.hh"
39 #include "G4ApplicationState.hh"
40 #include "G4UIcommand.hh"
41 #include "G4UImessenger.hh"
42
43 #include <map>
44 #include <vector>
45
46 class G4UIdirectory;
47
48 class G4GenericMessenger : public G4UImessenge
49 {
50 public:
51 // Contructor
52 G4GenericMessenger(void* obj, const G4Stri
53
54 // Destructor
55 ~G4GenericMessenger() override;
56
57 // The concrete, but generic implementatio
58 G4String GetCurrentValue(G4UIcommand* comm
59
60 // The concrete, generic implementation o
61 // the string "newValue" to action.
62 void SetNewValue(G4UIcommand* command, G4S
63
64 public:
65 struct Command
66 {
67 enum UnitSpec
68 {
69 UnitCategory,
70 UnitDefault
71 };
72 Command(G4UIcommand* cmd, const std::t
73 Command() = default;
74
75 Command& SetStates(G4ApplicationState
76 {
77 command->AvailableForStates(s0);
78 return *this;
79 }
80 Command& SetStates(G4ApplicationState
81 {
82 command->AvailableForStates(s0, s1);
83 return *this;
84 }
85 Command& SetStates(G4ApplicationState
86 {
87 command->AvailableForStates(s0, s1,
88 return *this;
89 }
90 Command& SetStates(G4ApplicationState
91 G4ApplicationState
92 {
93 command->AvailableForStates(s0, s1,
94 return *this;
95 }
96 Command& SetStates(G4ApplicationState
97 G4ApplicationState
98 {
99 command->AvailableForStates(s0, s1,
100 return *this;
101 }
102 Command& SetRange(const G4String& rang
103 {
104 command->SetRange(range.c_str());
105 return *this;
106 }
107 Command& SetGuidance(const G4String& s
108 {
109 command->SetGuidance(s0);
110 return *this;
111 }
112 Command& SetUnit(const G4String&, Unit
113 Command& SetUnitCategory(const G4Strin
114 Command& SetDefaultUnit(const G4String
115 Command& SetParameterName(const G4Stri
116 Command& SetParameterName(G4int pIdx,
117 Command& SetParameterName(const G4Stri
118 G4bool = fal
119 Command& SetDefaultValue(const G4Strin
120 Command& SetDefaultValue(G4int pIdx, c
121 Command& SetCandidates(const G4String&
122 Command& SetCandidates(G4int pIdx, con
123 Command& SetToBeBroadcasted(G4bool s0)
124 {
125 command->SetToBeBroadcasted(s0);
126 return *this;
127 }
128 Command& SetToBeFlushed(G4bool s0)
129 {
130 command->SetToBeFlushed(s0);
131 return *this;
132 }
133 Command& SetWorkerThreadOnly(G4bool s0
134 {
135 command->SetWorkerThreadOnly(s0);
136 return *this;
137 }
138
139 G4UIcommand* command = nullptr;
140 const std::type_info* type = nullptr;
141 };
142
143 struct Property : public Command
144 {
145 Property(const G4AnyType& var, G4UIcom
146 : Command(cmd, var.TypeInfo()), vari
147 {}
148 Property() = default;
149 G4AnyType variable;
150 };
151
152 struct Method : public Command
153 {
154 Method(const G4AnyMethod& fun, void* o
155 : Command(cmd, fun.ArgType()), metho
156 {}
157 Method() = default;
158 G4AnyMethod method;
159 void* object = nullptr;
160 };
161
162 // Declare Methods
163
164 Command& DeclareProperty(const G4String& n
165 const G4String& d
166 Command& DeclarePropertyWithUnit(const G4S
167 const G4A
168 Command& DeclareMethod(const G4String& nam
169 Command& DeclareMethodWithUnit(const G4Str
170 const G4Any
171 void SetDirectory(const G4String& dir) { d
172 void SetGuidance(const G4String& s);
173 void Sort(G4bool val = true)
174 {
175 if (dircmd != nullptr) {
176 dircmd->Sort(val);
177 }
178 }
179
180 private:
181 std::map<G4String, Property> properties;
182 std::map<G4String, Method> methods;
183 G4UIdirectory* dircmd = nullptr;
184 G4String directory;
185 void* object = nullptr;
186 };
187
188 #endif
189