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