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