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