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