| 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 // G4UIparameter
27 //
28 // Author: Makoto Asai, 1997
29 // --------------------------------------------------------------------
30
31 #include "G4UIparameter.hh"
32
33 #include "G4Tokenizer.hh"
34 #include "G4UIcommand.hh"
35 #include "G4UIcommandStatus.hh"
36 #include "G4UIparsing.hh"
37 #include "G4ios.hh"
38
39 // --------------------------------------------------------------------
40 G4UIparameter::G4UIparameter(char theType)
41 {
42 parameterType = theType;
43 }
44
45 // --------------------------------------------------------------------
46 G4UIparameter::G4UIparameter(const char* theName, char theType, G4bool theOmittable)
47 {
48 parameterName = theName;
49 parameterType = theType;
50 omittable = theOmittable;
51 }
52
53 // --------------------------------------------------------------------
54 G4UIparameter::~G4UIparameter() = default;
55
56 // --------------------------------------------------------------------
57 void G4UIparameter::List()
58 {
59 G4cout << G4endl << "Parameter : " << parameterName << G4endl;
60 if (!parameterGuidance.empty()) {
61 G4cout << parameterGuidance << G4endl;
62 }
63 G4cout << " Parameter type : " << parameterType << G4endl;
64 if (omittable) {
65 G4cout << " Omittable : True" << G4endl;
66 }
67 else {
68 G4cout << " Omittable : False" << G4endl;
69 }
70 if (currentAsDefaultFlag) {
71 G4cout << " Default value : taken from the current value" << G4endl;
72 }
73 else if (!defaultValue.empty()) {
74 G4cout << " Default value : " << defaultValue << G4endl;
75 }
76 if (!rangeExpression.empty()) {
77 G4cout << " Parameter range : " << rangeExpression << G4endl;
78 }
79 if (!parameterCandidate.empty()) {
80 G4cout << " Candidates : " << parameterCandidate << G4endl;
81 }
82 }
83
84 // --------------------------------------------------------------------
85 void G4UIparameter::SetDefaultValue(G4int theDefaultValue)
86 {
87 defaultValue = G4UIparsing::TtoS(theDefaultValue);
88 }
89
90 // --------------------------------------------------------------------
91 void G4UIparameter::SetDefaultValue(G4long theDefaultValue)
92 {
93 defaultValue = G4UIparsing::TtoS(theDefaultValue);
94 }
95
96 // --------------------------------------------------------------------
97 void G4UIparameter::SetDefaultValue(G4double theDefaultValue)
98 {
99 defaultValue = G4UIparsing::TtoS(theDefaultValue);
100 }
101
102 // --------------------------------------------------------------------
103 void G4UIparameter::SetDefaultUnit(const char* theDefaultUnit)
104 {
105 char type = (char)std::toupper(parameterType);
106 if (type != 'S') {
107 G4ExceptionDescription ed;
108 ed << "This method can be used only for a string-type parameter that is "
109 "used to specify a unit.\n"
110 << "This parameter <" << parameterName << "> is defined as ";
111 switch (type) {
112 case 'D':
113 ed << "double.";
114 break;
115 case 'I':
116 ed << "integer.";
117 break;
118 case 'L':
119 ed << "long int.";
120 break;
121 case 'B':
122 ed << "bool.";
123 break;
124 default:
125 ed << "undefined.";
126 }
127 G4Exception("G4UIparameter::SetDefaultUnit", "INTERCOM2010", FatalException, ed);
128 }
129 SetDefaultValue(theDefaultUnit);
130 SetParameterCandidates(G4UIcommand::UnitsList(G4UIcommand::CategoryOf(theDefaultUnit)));
131 }
132
133 // ---------- CheckNewValue() related routines ------------------------
134
135 G4int G4UIparameter::CheckNewValue(const char* newValue)
136 {
137 if (!TypeCheck(newValue)) {
138 return fParameterUnreadable;
139 }
140 if (!G4UIparsing::RangeCheck(*this, newValue)) {
141 return fParameterOutOfRange;
142 }
143 if (!CandidateCheck(newValue)) {
144 return fParameterOutOfCandidates;
145 }
146 return 0; // succeeded
147 }
148
149 // --------------------------------------------------------------------
150 G4bool G4UIparameter::CandidateCheck(const char* newValue)
151 {
152 if (parameterCandidate.empty()) {
153 return true;
154 }
155
156 G4Tokenizer candidateTokenizer(parameterCandidate);
157 G4String aToken;
158 while (!(aToken = candidateTokenizer()).empty()) {
159 if (aToken == newValue) {
160 return true;
161 }
162 }
163 G4cerr << "parameter value (" << newValue << ") is not listed in the candidate List." << G4endl;
164 G4cerr << " Candidates are:";
165 G4Tokenizer candidateListTokenizer(parameterCandidate);
166 while (!(aToken = candidateListTokenizer()).empty()) {
167 G4cerr << ' ' << aToken;
168 }
169 G4cerr << G4endl;
170
171 return false;
172 }
173
174 // --------------------------------------------------------------------
175 G4bool G4UIparameter::TypeCheck(const char* newValue)
176 {
177 G4String newValueString(newValue);
178 char type = (char)std::toupper(parameterType);
179 switch (type) {
180 case 'D':
181 if (!G4UIparsing::IsDouble(newValueString.data())) {
182 G4cerr << newValue << ": double value expected." << G4endl;
183 return false;
184 }
185 break;
186 case 'I':
187 if (!G4UIparsing::IsInt(newValueString.data(), 10)) {
188 G4cerr << newValue << ": integer expected." << G4endl;
189 return false;
190 }
191 break;
192 case 'L':
193 if (!G4UIparsing::IsInt(newValueString.data(), 20)) {
194 G4cerr << newValue << ": long int expected." << G4endl;
195 return false;
196 }
197 break;
198 case 'S':
199 break;
200 case 'B':
201 G4StrUtil::to_upper(newValueString);
202 if (newValueString == "Y" || newValueString == "N" || newValueString == "YES"
203 || newValueString == "NO" || newValueString == "1" || newValueString == "0"
204 || newValueString == "T" || newValueString == "F" || newValueString == "TRUE"
205 || newValueString == "FALSE")
206 {
207 return true;
208 }
209
210 G4cerr << newValue << ": bool expected." << G4endl;
211 return false;
212
213 default:;
214 }
215 return true;
216 }
217