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