| 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 // G4UIcmdWithABool 26 // G4UIcmdWithABool
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 Boolean value. Boolean value can be 31 // takes a Boolean value. Boolean value can be in the following notations:
32 // TRUE : 32 // TRUE :
33 // 1 t T true TRUE 33 // 1 t T true TRUE
34 // FALSE : 34 // FALSE :
35 // 0 f F false FALSE 35 // 0 f F false FALSE
36 // General information of G4UIcommand is given 36 // General information of G4UIcommand is given in G4UIcommand.hh
37 37
38 // Author: M.Asai, 1998 38 // Author: M.Asai, 1998
39 // ------------------------------------------- 39 // --------------------------------------------------------------------
40 #ifndef G4UIcmdWithABool_hh 40 #ifndef G4UIcmdWithABool_hh
41 #define G4UIcmdWithABool_hh 1 41 #define G4UIcmdWithABool_hh 1
42 42
43 #include "G4UIcommand.hh" 43 #include "G4UIcommand.hh"
44 44
45 class G4UIcmdWithABool : public G4UIcommand 45 class G4UIcmdWithABool : public G4UIcommand
46 { 46 {
47 public: 47 public:
48 // Constructor. The command string with fu << 48
49 // and the pointer to the messenger must b <<
50 G4UIcmdWithABool(const char* theCommandPat 49 G4UIcmdWithABool(const char* theCommandPath, G4UImessenger* theMessenger);
>> 50 // Constructor. The command string with full path directory
>> 51 // and the pointer to the messenger must be given
51 52
52 // Set the parameter name for a Boolean pa << 53 static G4bool GetNewBoolValue(const char* paramString);
53 // If "omittable" is set as true, the user << 54 // Convert string which represents a boolean value to G4bool
54 // the value when the command is applied. <<
55 // the user must supply a Boolean value. <<
56 // "currentAsDefault" flag is valid only i <<
57 // flag is true, the current value is used <<
58 // user omits the parameter. If this flag <<
59 // next SetDefaultValue() method is used <<
60 void SetParameterName(const char* theName, <<
61 55
62 // Set the default value of the parameter. << 56 void SetParameterName(const char* theName, G4bool omittable,
63 // when the user of this command omits the << 57 G4bool currentAsDefault = false);
64 // "omittable" is true and "currentAsDefau << 58 // Set the parameter name for a Boolean parameter.
65 void SetDefaultValue(G4bool defVal); << 59 // If "omittable" is set as true, the user of this command can omit
>> 60 // the value when the command is applied. If "omittable" is false,
>> 61 // the user must supply a Boolean value.
>> 62 // "currentAsDefault" flag is valid only if "omittable" is true. If this
>> 63 // flag is true, the current value is used as the default value when the
>> 64 // user omits the parameter. If this flag is false, the value given by the
>> 65 // next SetDefaultValue() method is used
66 66
67 // Convert string which represents a boole << 67 void SetDefaultValue(G4bool defVal);
68 static G4bool GetNewBoolValue(const char* << 68 // Set the default value of the parameter. This default value is used
>> 69 // when the user of this command omits the parameter value, and
>> 70 // "omittable" is true and "currentAsDefault" is false
69 }; 71 };
70 72
71 #endif 73 #endif
72 74