| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // G4UIcmdWithABool <<
27 // 23 //
28 // Class description: << 24 // $Id: G4UIcmdWithABool.hh,v 1.5 2002/04/26 22:03:35 asaim Exp $
>> 25 // GEANT4 tag $Name: geant4-05-02-patch-01 $
>> 26 //
29 // 27 //
30 // A concrete class of G4UIcommand. The comman <<
31 // takes a Boolean value. Boolean value can be <<
32 // TRUE : <<
33 // 1 t T true TRUE <<
34 // FALSE : <<
35 // 0 f F false FALSE <<
36 // General information of G4UIcommand is given <<
37 28
38 // Author: M.Asai, 1998 << 29 #ifndef G4UIcmdWithABool_H
39 // ------------------------------------------- << 30 #define G4UIcmdWithABool_H 1
40 #ifndef G4UIcmdWithABool_hh <<
41 #define G4UIcmdWithABool_hh 1 <<
42 31
43 #include "G4UIcommand.hh" 32 #include "G4UIcommand.hh"
44 33
>> 34 // class description:
>> 35 // A concrete class of G4UIcommand. The command defined by this class
>> 36 // takes a boolean value. Boolean value can be the following notations.
>> 37 // TRUE :
>> 38 // 1 t T true TRUE
>> 39 // FALSE :
>> 40 // 0 f F false FALSE
>> 41 // General information of G4UIcommand is given in G4UIcommand.hh.
>> 42
45 class G4UIcmdWithABool : public G4UIcommand 43 class G4UIcmdWithABool : public G4UIcommand
46 { 44 {
47 public: << 45 public: // with description
48 // Constructor. The command string with fu << 46 G4UIcmdWithABool
49 // and the pointer to the messenger must b << 47 (const char * theCommandPath,G4UImessenger * theMessenger);
50 G4UIcmdWithABool(const char* theCommandPat << 48 // Constructor. The command string with full path directory
51 << 49 // and the pointer to the messenger must be given.
52 // Set the parameter name for a Boolean pa << 50 G4bool GetNewBoolValue(const char* paramString);
53 // If "omittable" is set as true, the user << 51 // Convert string which represents a boolean value to G4bool.
54 // the value when the command is applied. << 52 G4String ConvertToString(G4bool intValue);
55 // the user must supply a Boolean value. << 53 // Convert a boolean value to a string. This method must be used by
56 // "currentAsDefault" flag is valid only i << 54 // the messenger for its GetCurrentValues() method.
57 // flag is true, the current value is used << 55 void SetParameterName(const char * theName,G4bool omittable,
58 // user omits the parameter. If this flag << 56 G4bool currentAsDefault=false);
59 // next SetDefaultValue() method is used << 57 // Set the parameter name for a boolean parameter.
60 void SetParameterName(const char* theName, << 58 // If "omittable" is set as true, the user of this command can ommit
61 << 59 // the value when he/she applies the command. If "omittable" is false,
62 // Set the default value of the parameter. << 60 // the user must supply a boolean value.
63 // when the user of this command omits the << 61 // "currentAsDefault" flag is valid only if "omittable" is true. If this
64 // "omittable" is true and "currentAsDefau << 62 // flag is true, the current value is used as the default value when the
>> 63 // user ommit the parameter. If this flag is false, the value given by the
>> 64 // next SetDefaultValue() method is used.
65 void SetDefaultValue(G4bool defVal); 65 void SetDefaultValue(G4bool defVal);
66 << 66 // Set the default value of the parameter. This default value is used
67 // Convert string which represents a boole << 67 // when the user of this command ommits the parameter value, and
68 static G4bool GetNewBoolValue(const char* << 68 // "ommitable" is true and "currentAsDefault" is false.
69 }; 69 };
70 70
71 #endif 71 #endif
72 72