Geant4 Cross Reference |
1 // 1 // 2 // ******************************************* 2 // ******************************************************************** 3 // * License and Disclaimer << 3 // * DISCLAIMER * 4 // * 4 // * * 5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers * 6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which * 7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: * 8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license * 9 // * include a list of copyright holders. << 10 // * 9 // * * 11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file << 14 // * use. * 16 // * for the full disclaimer and the limitatio << 17 // * 15 // * * 18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the * 19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. * 20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work * 21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this * 22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. * 23 // * acceptance of all terms of the Geant4 Sof << 24 // ******************************************* 21 // ******************************************************************** 25 // 22 // 26 // G4UIcommand << 27 // 23 // 28 // Class description: << 24 // $Id: G4UIcommand.hh,v 1.14 2004/05/16 18:42:30 asaim Exp $ >> 25 // GEANT4 tag $Name: geant4-07-01 $ 29 // 26 // 30 // This G4UIcommand is the "concrete" base cla << 27 // 31 // used by Geant4 (G)UI. The user can use this << 32 // arguments of a command are not suitable wit << 33 // classes. << 34 // Some methods defined in this base class are << 35 28 36 // Author: Makoto Asai (SLAC), 1998 << 29 #ifndef G4UIcommand_h 37 // ------------------------------------------- << 30 #define G4UIcommand_h 1 38 #ifndef G4UIcommand_hh << 39 #define G4UIcommand_hh 1 << 40 31 41 #include "G4ApplicationState.hh" << 42 #include "G4ThreeVector.hh" << 43 #include "G4UIparameter.hh" 32 #include "G4UIparameter.hh" >> 33 class G4UImessenger; 44 #include "globals.hh" 34 #include "globals.hh" 45 << 35 #include "G4ApplicationState.hh" 46 #include <vector> 36 #include <vector> >> 37 #include "G4UItokenNum.hh" >> 38 #include "G4ThreeVector.hh" 47 39 48 class G4UImessenger; << 40 // class description: >> 41 // >> 42 // This G4UIcommand is the "concrete" base class which represents a command >> 43 // used by Geant4 (G)UI. The user can use this class in case the parameter >> 44 // arguments of a command are not suitable with respect to the derived command >> 45 // classes. >> 46 // Some methods defined in this base class are used by the derived classes. >> 47 // 49 48 50 class G4UIcommand << 49 class G4UIcommand 51 { 50 { >> 51 public: >> 52 G4UIcommand(); >> 53 public: // with description >> 54 G4UIcommand(const char * theCommandPath, G4UImessenger * theMessenger); >> 55 // Constructor. The command string with full path directory >> 56 // and the pointer to the messenger must be given. >> 57 public: >> 58 virtual ~G4UIcommand(); >> 59 >> 60 G4int operator==(const G4UIcommand &right) const; >> 61 G4int operator!=(const G4UIcommand &right) const; >> 62 >> 63 G4int DoIt(G4String parameterList); >> 64 G4String GetCurrentValue(); >> 65 public: // with description >> 66 void AvailableForStates(G4ApplicationState s1); >> 67 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2); >> 68 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2, >> 69 G4ApplicationState s3); >> 70 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2, >> 71 G4ApplicationState s3,G4ApplicationState s4); >> 72 void AvailableForStates(G4ApplicationState s1,G4ApplicationState s2, >> 73 G4ApplicationState s3,G4ApplicationState s4, >> 74 G4ApplicationState s5); >> 75 // These methods define the states where the command is available. >> 76 // Once one of these commands is invoked, the command application will >> 77 // be denied when Geant4 is NOT in the assigned states. 52 public: 78 public: 53 // Dummy default constructor << 79 G4bool IsAvailable(); 54 G4UIcommand() = default; << 80 virtual void List(); 55 << 56 // Constructor. The command string with fu << 57 // and the pointer to the messenger must b << 58 // If tBB is set to false, this command wo << 59 // This tBB parameter could be changed wit << 60 // except for G4UIdirectory << 61 G4UIcommand(const char* theCommandPath, G4 << 62 << 63 virtual ~G4UIcommand(); << 64 << 65 G4bool operator==(const G4UIcommand& right << 66 G4bool operator!=(const G4UIcommand& right << 67 << 68 virtual G4int DoIt(const G4String& paramet << 69 << 70 G4String GetCurrentValue(); << 71 << 72 // These methods define the states where t << 73 // Once one of these commands is invoked, << 74 // be denied when Geant4 is NOT in the ass << 75 void AvailableForStates(G4ApplicationState << 76 void AvailableForStates(G4ApplicationState << 77 void AvailableForStates(G4ApplicationState << 78 void AvailableForStates(G4ApplicationState << 79 G4ApplicationState << 80 void AvailableForStates(G4ApplicationState << 81 G4ApplicationState << 82 << 83 G4bool IsAvailable(); << 84 << 85 virtual void List(); << 86 << 87 // Static methods for conversion from valu << 88 // These methods are to be used by GetCurr << 89 // of concrete messengers << 90 static G4String ConvertToString(G4bool boo << 91 static G4String ConvertToString(G4int intV << 92 static G4String ConvertToString(G4long lon << 93 static G4String ConvertToString(G4double d << 94 static G4String ConvertToString(G4double d << 95 static G4String ConvertToString(const G4Th << 96 static G4String ConvertToString(const G4Th << 97 << 98 // Static methods for conversion from a st << 99 // type. These methods are to be used dire << 100 // of concrete messengers, or GetNewXXXVal << 101 // this G4UIcommand class << 102 static G4bool ConvertToBool(const char* st << 103 static G4int ConvertToInt(const char* st); << 104 static G4long ConvertToLongInt(const char* << 105 static G4double ConvertToDouble(const char << 106 static G4double ConvertToDimensionedDouble << 107 static G4ThreeVector ConvertTo3Vector(cons << 108 static G4ThreeVector ConvertToDimensioned3 << 109 << 110 // Static methods for unit and its categor << 111 static G4double ValueOf(const char* unitNa << 112 static G4String CategoryOf(const char* uni << 113 static G4String UnitsList(const char* unit << 114 << 115 // Defines the range the command parameter << 116 // The variable name(s) appear in the rang << 117 // as the name(s) of the parameter(s). << 118 // All the C++ syntax of relational operat << 119 // range expression << 120 inline void SetRange(const char* rs) { ran << 121 << 122 inline const G4String& GetRange() const { << 123 inline std::size_t GetGuidanceEntries() co << 124 inline const G4String& GetGuidanceLine(G4i << 125 inline const G4String& GetCommandPath() co << 126 inline const G4String& GetCommandName() co << 127 inline std::size_t GetParameterEntries() c << 128 inline G4UIparameter* GetParameter(G4int i << 129 inline std::vector<G4ApplicationState>* Ge << 130 inline G4UImessenger* GetMessenger() const << 131 << 132 // Defines a parameter. This method is use << 133 // classes but the user can directly use t << 134 // a command, without using the derived cl << 135 // of the parameters is the order of invok << 136 inline void SetParameter(G4UIparameter* co << 137 { << 138 parameter.push_back(newParameter); << 139 } << 140 << 141 // Adds a guidance line. Unlimited times o << 142 // allowed. The given lines of guidance wi << 143 // The first line of the guidance will be << 144 // command, i.e. one line list of the comm << 145 inline void SetGuidance(const char* aGuida << 146 << 147 inline const G4String GetTitle() const << 148 { << 149 return (commandGuidance.empty()) ? G4Str << 150 } << 151 << 152 inline void SetToBeBroadcasted(G4bool val) << 153 inline G4bool ToBeBroadcasted() const { re << 154 inline void SetToBeFlushed(G4bool val) { t << 155 inline G4bool ToBeFlushed() const { return << 156 inline void SetWorkerThreadOnly(G4bool val << 157 inline G4bool IsWorkerThreadOnly() const { << 158 << 159 inline void CommandFailed(G4int errCode, G << 160 { << 161 commandFailureCode = errCode; << 162 failureDescription = ed.str(); << 163 } << 164 inline void CommandFailed(G4ExceptionDescr << 165 { << 166 commandFailureCode = 1; << 167 failureDescription = ed.str(); << 168 } << 169 inline G4int IfCommandFailed() { return co << 170 inline const G4String& GetFailureDescripti << 171 inline void ResetFailure() << 172 { << 173 commandFailureCode = 0; << 174 failureDescription = ""; << 175 } << 176 81 >> 82 public: // with description >> 83 static G4String ConvertToString(G4bool boolVal); >> 84 static G4String ConvertToString(G4int intValue); >> 85 static G4String ConvertToString(G4double doubleValue); >> 86 static G4String ConvertToString(G4double doubleValue,const char* unitName); >> 87 static G4String ConvertToString(G4ThreeVector vec); >> 88 static G4String ConvertToString(G4ThreeVector vec,const char* unitName); >> 89 // Static methods for conversion from value(s) to a string. These methods are to be >> 90 // used by GetCurrentValues() methods of concrete messengers. >> 91 >> 92 static G4bool ConvertToBool(const char* st); >> 93 static G4int ConvertToInt(const char* st); >> 94 static G4double ConvertToDouble(const char* st); >> 95 static G4double ConvertToDimensionedDouble(const char* st); >> 96 static G4ThreeVector ConvertTo3Vector(const char* st); >> 97 static G4ThreeVector ConvertToDimensioned3Vector(const char* st); >> 98 // Static methods for conversion from a string to a value of the returning type. >> 99 // These methods are to be used directly by SetNewValues() methods of concrete >> 100 // messengers, or GetNewXXXValue() of classes derived from this G4UIcommand class. >> 101 >> 102 static G4double ValueOf(const char* unitName); >> 103 static G4String CategoryOf(const char* unitName); >> 104 static G4String UnitsList(const char* unitCategory); >> 105 // Static methods for unit and its category. >> 106 >> 107 private: >> 108 void G4UIcommandCommonConstructorCode (const char * theCommandPath); >> 109 G4UImessenger *messenger; >> 110 G4String commandPath; >> 111 G4String commandName; >> 112 G4String rangeString; >> 113 std::vector<G4UIparameter*> parameter; >> 114 std::vector<G4String> commandGuidance; >> 115 std::vector<G4ApplicationState> availabelStateList; >> 116 >> 117 public: // with description >> 118 inline void SetRange(const char* rs) >> 119 { rangeString = rs; } >> 120 // Defines the range the command parameter(s) can take. >> 121 // The variable name(s) appear in the range expression must be same >> 122 // as the name(s) of the parameter(s). >> 123 // All the C++ syntax of relational operators are allowed for the >> 124 // range expression. 177 public: 125 public: 178 enum CommandType << 126 inline const G4String & GetRange() const 179 { << 127 { return rangeString; }; 180 BaseClassCmd, << 128 inline G4int GetGuidanceEntries() const 181 WithoutParameterCmd, << 129 { return commandGuidance.size(); } 182 WithABoolCmd, << 130 inline const G4String & GetGuidanceLine(G4int i) const 183 WithAnIntegerCmd, << 131 { return commandGuidance[i]; } 184 WithALongIntCmd, << 132 inline const G4String & GetCommandPath() const 185 WithADoubleCmd, << 133 { return commandPath; } 186 WithADoubleAndUnitCmd, << 134 inline const G4String & GetCommandName() const 187 With3VectorCmd, << 135 { return commandName; } 188 With3VectorAndUnitCmd, << 136 inline G4int GetParameterEntries() const 189 WithAStringCmd, << 137 { return parameter.size(); } 190 CmdDirectory = -1 << 138 inline G4UIparameter * GetParameter(G4int i) const 191 }; << 139 { return parameter[i]; } 192 << 140 inline std::vector<G4ApplicationState>* GetStateList() 193 inline CommandType GetCommandType() const << 141 { return &availabelStateList; } 194 void SetCommandType(CommandType); << 142 public: // with description 195 << 143 inline void SetParameter(G4UIparameter *const newParameter) 196 inline void SetDefaultSortFlag(G4bool val) << 144 { >> 145 parameter.push_back( newParameter ); >> 146 newVal.resize( parameter.size() ); >> 147 } >> 148 // Defines a parameter. This method is used by the derived command classes >> 149 // but the user can directly use this command when he/she defines a command >> 150 // by hem(her)self without using the derived class. For this case, the order >> 151 // of the parameters is the order of invoking this method. >> 152 inline void SetGuidance(const char * aGuidance) >> 153 { >> 154 commandGuidance.push_back( G4String( aGuidance ) ); >> 155 } >> 156 // Adds a guidance line. Unlimitted number of invokation of this method is >> 157 // allowed. The given lines of guidance will appear for the help. The first >> 158 // line of the guidance will be used as the title of the command, i.e. one >> 159 // line list of the commands. >> 160 public: >> 161 inline const G4String GetTitle() const >> 162 { >> 163 if(commandGuidance.size() == 0) >> 164 { return G4String("...Title not available..."); } >> 165 else >> 166 { return commandGuidance[0]; } >> 167 } 197 168 198 protected: 169 protected: 199 G4int CheckNewValue(const char* newValue); 170 G4int CheckNewValue(const char* newValue); 200 171 201 G4bool toBeBroadcasted = false; << 172 // --- the following is used by CheckNewValue() -------- 202 G4bool toBeFlushed = false; << 203 G4bool workerThreadOnly = false; << 204 << 205 G4int commandFailureCode = 0; << 206 G4String failureDescription = ""; << 207 << 208 G4bool ifSort = false; << 209 << 210 private: 173 private: 211 void G4UIcommandCommonConstructorCode(cons << 174 G4int TypeCheck(const char* t); 212 << 175 G4int RangeCheck(const char* t); 213 private: << 176 G4int IsInt(const char* str, short maxLength); 214 CommandType commandType = BaseClassCmd; << 177 G4int IsDouble(const char* str); 215 G4UImessenger* messenger = nullptr; << 178 G4int ExpectExponent(const char* str); 216 G4String commandPath; << 179 // syntax nodes 217 G4String commandName; << 180 yystype Expression( void ); 218 G4String rangeExpression; << 181 yystype LogicalORExpression( void ); 219 std::vector<G4UIparameter*> parameter; << 182 yystype LogicalANDExpression( void ); 220 std::vector<G4String> commandGuidance; << 183 yystype EqualityExpression ( void ); 221 std::vector<G4ApplicationState> availabelS << 184 yystype RelationalExpression( void ); >> 185 yystype AdditiveExpression( void ); >> 186 yystype MultiplicativeExpression( void ); >> 187 yystype UnaryExpression( void ); >> 188 yystype PrimaryExpression( void ); >> 189 // semantics routines >> 190 G4int Eval2( yystype arg1, G4int op, yystype arg2 ); >> 191 G4int CompareInt( G4int arg1, G4int op, G4int arg2); >> 192 G4int CompareDouble( G4double arg1, G4int op, G4double arg2); >> 193 // utility >> 194 tokenNum Yylex( void ); // returns next token >> 195 unsigned IndexOf( const char* ); // returns the index of the var name >> 196 unsigned IsParameter( const char* ); // returns 1 or 0 >> 197 G4int G4UIpGetc( void ); // read one char from rangeBuf >> 198 G4int G4UIpUngetc( G4int c ); // put back >> 199 G4int Backslash( G4int c ); >> 200 G4int Follow( G4int expect, G4int ifyes, G4int ifno ); >> 201 G4String TokenToStr(G4int token); >> 202 void PrintToken(void); // for debug >> 203 // data >> 204 G4String rangeBuf; >> 205 G4int bp; // buffer pointer for rangeBuf >> 206 tokenNum token; >> 207 yystype yylval; >> 208 std::vector<yystype> newVal; >> 209 G4int paramERR; 222 }; 210 }; 223 211 224 #endif 212 #endif >> 213 225 214