Geant4 Cross Reference |
1 // 2 // ******************************************************************** 3 // * License and Disclaimer * 4 // * * 5 // * The Geant4 software is copyright of the Copyright Holders of * 6 // * the Geant4 Collaboration. It is provided under the terms and * 7 // * conditions of the Geant4 Software License, included in the file * 8 // * LICENSE and available at http://cern.ch/geant4/license . These * 9 // * include a list of copyright holders. * 10 // * * 11 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file LICENSE and URL above * 16 // * for the full disclaimer and the limitation of liability. * 17 // * * 18 // * This code implementation is the result of the scientific and * 19 // * technical work of the GEANT4 collaboration. * 20 // * By using, copying, modifying or distributing the software (or * 21 // * any work based on the software) you agree to acknowledge its * 22 // * use in resulting scientific publications, and indicate your * 23 // * acceptance of all terms of the Geant4 Software license. * 24 // ******************************************************************** 25 // 26 // G4UIcmdWith3VectorAndUnit 27 // 28 // Class description: 29 // 30 // A concrete class of G4UIcommand. The command defined by this class 31 // takes three double values and a unit. 32 // General information of G4UIcommand is given in G4UIcommand.hh 33 34 // Author: M.Asai, 1998 35 // -------------------------------------------------------------------- 36 #ifndef G4UIcmdWith3VectorAndUnit_hh 37 #define G4UIcmdWith3VectorAndUnit_hh 1 38 39 #include "G4ThreeVector.hh" 40 #include "G4UIcommand.hh" 41 42 class G4UIcmdWith3VectorAndUnit : public G4UIcommand 43 { 44 public: 45 // Constructor. The command string with full path directory 46 // and the pointer to the messenger must be given 47 G4UIcmdWith3VectorAndUnit(const char* theCommandPath, G4UImessenger* theMessenger); 48 49 G4int DoIt(const G4String& parameterList) override; 50 51 // Convert a 3 vector value to a string of digits and unit. Best unit is 52 // chosen from the unit category of default unit (in case SetDefaultUnit() 53 // is defined) or category defined by SetUnitCategory() 54 G4String ConvertToStringWithBestUnit(const G4ThreeVector& vec); 55 56 // Convert a 3 vector value to a string of digits and unit. Best unit is 57 // chosen from the category defined by SetUnitCategory() in case default 58 // unit is not defined 59 G4String ConvertToStringWithDefaultUnit(const G4ThreeVector& vec); 60 61 // Set the parameter names for three parameters. Names are used by 62 // the range checking routine. 63 // If "omittable" is set as true, the user of this command can omit 64 // the value(s) when the command is applied. If "omittable" is false, 65 // the user must supply all three values. 66 // "currentAsDefault" flag is valid only if "omittable" is true. If this 67 // flag is true, the current values are used as the default values when 68 // the user omit some of the parameters. If this flag is false, the values 69 // given by the next SetDefaultValue() method are used 70 void SetParameterName(const char* theNameX, const char* theNameY, const char* theNameZ, 71 G4bool omittable, G4bool currentAsDefault = false); 72 73 // Set the default values of the parameters. These default values are used 74 // when the user of this command omits some of the parameter values, and 75 // "omittable" is true and "currentAsDefault" is false 76 void SetDefaultValue(const G4ThreeVector& defVal); 77 78 // These three methods must be used alternatively. 79 // The user cannot omit the unit as the fourth parameter of the command 80 // if SetUnitCategory() or SetUnitCandidates() is used, while the unit 81 // defined by SetDefaultUnit() method is used as the default unit so that 82 // the user can omit the fourth parameter. 83 // SetUnitCategory() defines the category of the units which will be 84 // accepted. 85 // The available categories can be found in G4SystemOfUnits.hh in 'global' 86 // category. Only the units categorized in the given category are accepted 87 // as the fourth parameter of the command. 88 // SetUnitCandidates() defines the candidates of units. Units listed in 89 // the argument of this method must be separated by space(s). Only the 90 // units listed in the candidate list are accepted as the fourth parameter 91 // of the command. 92 // SetDefaultUnit() defines the default unit and also defines the category 93 // of the allowed units. Thus only the units categorized as the given 94 // default unit will be accepted. 95 void SetUnitCategory(const char* unitCategory); 96 void SetUnitCandidates(const char* candidateList); 97 void SetDefaultUnit(const char* defUnit); 98 99 // Convert string which represents three double values and a unit to 100 // G4ThreeVector. Values are converted to the Geant4 internal unit 101 static G4ThreeVector GetNew3VectorValue(const char* paramString); 102 103 // Convert string which represents three double values and a unit to 104 // G4ThreeVector. Values are NOT converted to the Geant4 internal unit 105 // but just as the given string 106 static G4ThreeVector GetNew3VectorRawValue(const char* paramString); 107 108 // Convert the unit string to the value of the unit. "paramString" 109 // must contain three double values AND a unit string 110 static G4double GetNewUnitValue(const char* paramString); 111 }; 112 113 #endif 114