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 // G4UImessenger 27 // 28 // Class description: 29 // 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 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 t 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 72 inline G4bool CommandsShouldBeInMaster() c 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 87 void CreateDirectory(const G4String& path, 88 G4bool commandsToBeBr 89 template<typename T> 90 T* CreateCommand(const G4String& cname, co 91 92 protected: 93 G4UIdirectory* baseDir = nullptr; // used 94 G4String baseDirName = ""; // used if dir 95 G4bool commandsShouldBeInMaster = false; 96 }; 97 98 // Inline template implementations 99 100 template<typename T> 101 T* G4UImessenger::CreateCommand(const G4String 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