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 // G4UIcmdWithADoubleAndUnit << 27 // 26 // 28 // Class description: << 27 // $Id: G4UIcmdWithADoubleAndUnit.hh,v 1.8 2006/06/29 19:07:57 gunter Exp $ >> 28 // GEANT4 tag $Name: geant4-09-01 $ >> 29 // 29 // 30 // 30 // A concrete class of G4UIcommand. The comman << 31 // takes a double value and a unit string. << 32 // General information of G4UIcommand is given << 33 31 34 // Author: M.Asai, 1998 << 32 #ifndef G4UIcmdWithADoubleAndUnit_H 35 // ------------------------------------------- << 33 #define G4UIcmdWithADoubleAndUnit_H 1 36 #ifndef G4UIcmdWithADoubleAndUnit_hh << 37 #define G4UIcmdWithADoubleAndUnit_hh 1 << 38 34 39 #include "G4UIcommand.hh" 35 #include "G4UIcommand.hh" 40 36 >> 37 // class description: >> 38 // A concrete class of G4UIcommand. The command defined by this class >> 39 // takes a double value and a unit string. >> 40 // General information of G4UIcommand is given in G4UIcommand.hh. >> 41 41 class G4UIcmdWithADoubleAndUnit : public G4UIc 42 class G4UIcmdWithADoubleAndUnit : public G4UIcommand 42 { 43 { 43 public: << 44 public: // with description 44 // Constructor. The command string with fu << 45 G4UIcmdWithADoubleAndUnit 45 // and the pointer to the messenger must b << 46 (const char * theCommandPath,G4UImessenger * theMessenger); 46 G4UIcmdWithADoubleAndUnit(const char* theC << 47 // Constructor. The command string with full path directory 47 << 48 // and the pointer to the messenger must be given. 48 G4int DoIt(const G4String& parameterList) << 49 static G4double GetNewDoubleValue(const char* paramString); 49 << 50 // Convert string which represents a double value and a unit to 50 // Convert a double value to a string of d << 51 // double. Value is converted to the Geant4 internal unit. 51 // chosen from the unit category of defaul << 52 static G4double GetNewDoubleRawValue(const char* paramString); 52 // is defined) or category defined by SetU << 53 // Convert string which represents a double value and a unit to >> 54 // double. Value is NOT converted to the Geant4 internal unit >> 55 // but just as the given string. >> 56 static G4double GetNewUnitValue(const char* paramString); >> 57 // Convert the unit string to the value of the unit. "paramString" >> 58 // must contain a double value AND a unit string. 53 G4String ConvertToStringWithBestUnit(G4dou 59 G4String ConvertToStringWithBestUnit(G4double val); 54 << 60 // Convert a double value to a string of digits and unit. Best unit is 55 // Convert a double value to a string of d << 61 // chosen from the unit category of default unit (in case SetDefaultUnit() 56 // chosen from the category defined by Set << 62 // is defined) or category defined by SetUnitCategory(). 57 // unit is not defined << 58 G4String ConvertToStringWithDefaultUnit(G4 63 G4String ConvertToStringWithDefaultUnit(G4double val); 59 << 64 // Convert a double value to a string of digits and unit. Best unit is 60 // Set the parameter name for double param << 65 // chosen from the category defined by SetUnitCategory() in case default 61 // the range checking function. << 66 // unit is not defined. 62 // If "omittable" is set as true, the user << 67 void SetParameterName(const char * theName,G4bool omittable, 63 // the value when the command is applied. << 68 G4bool currentAsDefault=false); >> 69 // Set the parameter name for double parameterxs. Name is used by >> 70 // the range checking routine. >> 71 // If "omittable" is set as true, the user of this command can ommit >> 72 // the value when he/she applies the command. If "omittable" is false, 64 // the user must supply a value. 73 // the user must supply a value. 65 // "currentAsDefault" flag is valid only i << 74 // "currentAsDefault" flag is valid only if "omittable" is true. If this 66 // flag is true, the current value is used << 75 // flag is true, the current value is used as the default value when the 67 // user omits the double parameter. If thi << 76 // user ommit the double parameter. If this flag is false, the value 68 // given by the next SetDefaultValue() met << 77 // given by the next SetDefaultValue() method is used. 69 void SetParameterName(const char* theName, << 70 << 71 // Set the default value of the parameter. << 72 // when the user of this command omits the << 73 // "omittable" is true and "currentAsDefau << 74 void SetDefaultValue(G4double defVal); 78 void SetDefaultValue(G4double defVal); 75 << 79 // Set the default value of the parameter. This default value is used 76 // These three methods must be used altern << 80 // when the user of this command ommits the parameter value, and 77 // The user cannot omit the unit as the se << 81 // "ommitable" is true and "curreutAsDefault" is false. 78 // if SetUnitCategory() or SetUnitCandidat << 82 void SetUnitCategory(const char * unitCategory); 79 // defined by SetDefaultUnit() method is u << 83 void SetUnitCandidates(const char * candidateList); 80 // the user can omit the second parameter. << 84 void SetDefaultUnit(const char * defUnit); 81 // SetUnitCategory() defines the category << 85 // These three methods must be used alternatively. 82 // accepted. << 86 // The user cannot ommit the unit as the second parameter of the command if 83 // The available categories can be found i << 87 // SetUnitCategory() or SetUnitCandidates() is used, while the unit defined 84 // category. Only the units categorized in << 88 // by SetDefaultUnit() method is used as the default unit so that the user can 85 // as the second parameter of the command. << 89 // ommits the second parameter. 86 // SetUnitCandidates() defines the candida << 90 // SetUnitCategory() defines the category of the units which will be accepted. 87 // the argument of this method must be sep << 91 // The available categories can be found in G4SystemOfUnits.hh in global category. 88 // units listed in the candidate list are << 92 // Only the units categorized in the given category are accepted as the second 89 // of the command. << 93 // parameter of the command. 90 // SetDefaultUnit() defines the default un << 94 // SetUnitCandidates() defines the candidates of units. Units listed in the 91 // of the allowed units. Thus only the uni << 95 // argument of this method must be separated by space(s). Only the units listed 92 // default unit will be accepted << 96 // in the candidate list are accepted as the second parameter of the command. 93 void SetUnitCategory(const char* unitCateg << 97 // SetDefaultUnit() defines the default unit and also it defines the category 94 void SetUnitCandidates(const char* candida << 98 // of the allowed units. Thus only the units categorized as the given default 95 void SetDefaultUnit(const char* defUnit); << 99 // unit will be accepted. 96 << 97 // Convert string which represents a doubl << 98 // double. Value is converted to the Geant << 99 static G4double GetNewDoubleValue(const ch << 100 << 101 // Convert string which represents a doubl << 102 // double. Value is NOT converted to the G << 103 // but just as the given string << 104 static G4double GetNewDoubleRawValue(const << 105 << 106 // Convert the unit string to the value of << 107 // must contain a double value AND a unit << 108 static G4double GetNewUnitValue(const char << 109 }; 100 }; 110 101 111 #endif 102 #endif 112 103