| 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 // G4UImessenger
27 //
28 // Class description:
29 //
30 // This class is the base class representing a messenger which keeps all basic
31 // commands. The user who wants to define some commands must create his/her
32 // own concrete class derived from this class. The user's concrete messenger
33 // must have a responsibility of creating and deleting commands. Also, it must
34 // take care of the delivering of the commands to the destination class and
35 // provide the current value(s) of the parameter(s)
36
37 // Author: Makoto Asai, 1998
38 // --------------------------------------------------------------------
39 #ifndef G4UImessenger_hh
40 #define G4UImessenger_hh 1
41
42 #include "G4UIdirectory.hh"
43 #include "G4ios.hh"
44 #include "globals.hh"
45
46 class G4UImessenger
47 {
48 public:
49 // Constructor. In the implementation of the concrete messenger,
50 // all commands related to the messenger must be constructed
51 G4UImessenger() = default;
52 G4UImessenger(const G4String& path, const G4String& dsc, G4bool commandsToBeBroadcasted = true);
53
54 // Destructor. In the implementation of the concrete messenger,
55 // all commands defined in the constructor must be deleted
56 virtual ~G4UImessenger();
57
58 // The concrete implementation of this method gets the current value(s)
59 // of the parameter(s) of the given command from the destination class,
60 // converts the value(s) to a string, and returns the string.
61 // Conversion could be done by the ConvertToString() method of
62 // corresponding G4UIcmdXXX classes if the command is an object of
63 // these G4UIcmdXXX classes
64 virtual G4String GetCurrentValue(G4UIcommand* command);
65
66 // The concrete implementation of this method converts the string
67 // "newValue" to value(s) of type(s) of the parameter(s).
68 // Converted methods corresponding to the type of the command can be
69 // used if the command is an object of G4UIcmdXXX classes
70 virtual void SetNewValue(G4UIcommand* command, G4String newValue);
71
72 inline G4bool CommandsShouldBeInMaster() const { return commandsShouldBeInMaster; }
73
74 protected:
75 G4String ItoS(G4int i);
76 G4String LtoS(G4long l);
77 G4String DtoS(G4double a);
78 G4String BtoS(G4bool b);
79 G4int StoI(const G4String& s);
80 G4long StoL(const G4String& s);
81 G4double StoD(const G4String& s);
82 G4bool StoB(const G4String& s);
83
84 void AddUIcommand(G4UIcommand* newCommand);
85
86 // Shortcut way for creating directory and commands
87 void CreateDirectory(const G4String& path, const G4String& dsc,
88 G4bool commandsToBeBroadcasted = true);
89 template<typename T>
90 T* CreateCommand(const G4String& cname, const G4String& dsc);
91
92 protected:
93 G4UIdirectory* baseDir = nullptr; // used if new object is created
94 G4String baseDirName = ""; // used if dir already exists
95 G4bool commandsShouldBeInMaster = false;
96 };
97
98 // Inline template implementations
99
100 template<typename T>
101 T* G4UImessenger::CreateCommand(const G4String& cname, const G4String& dsc)
102 {
103 G4String path;
104 if (cname[0] != '/') {
105 path = baseDirName + cname;
106 if (path[0] != '/') {
107 path = "/" + path;
108 }
109 }
110
111 T* command = new T(path.c_str(), this);
112 command->SetGuidance(dsc.c_str());
113
114 return command;
115 }
116
117 #endif
118