| 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 // G4UIcmdWithAnInteger <<
27 // 26 //
28 // Class description: << 27 // $Id: G4UIcmdWithAnInteger.hh,v 1.7 2006/06/29 19:08:01 gunter Exp $
>> 28 // GEANT4 tag $Name: geant4-08-03-patch-02 $
>> 29 //
29 // 30 //
30 // A concrete class of G4UIcommand. The comman <<
31 // takes an integer value. <<
32 // General information of G4UIcommand is given <<
33 31
34 // Author: M.Asai, 1998 << 32 #ifndef G4UIcmdWithAnInteger_H
35 // ------------------------------------------- << 33 #define G4UIcmdWithAnInteger_H 1
36 #ifndef G4UIcmdWithAnInteger_hh <<
37 #define G4UIcmdWithAnInteger_hh 1 <<
38 34
39 #include "G4UIcommand.hh" 35 #include "G4UIcommand.hh"
40 36
>> 37 // class description:
>> 38 // A concrete class of G4UIcommand. The command defined by this class
>> 39 // takes an integer value.
>> 40 // General information of G4UIcommand is given in G4UIcommand.hh.
>> 41
41 class G4UIcmdWithAnInteger : public G4UIcomman 42 class G4UIcmdWithAnInteger : public G4UIcommand
42 { 43 {
43 public: << 44 public: // with description
44 // Constructor. The command string with fu << 45 G4UIcmdWithAnInteger
45 // and the pointer to the messenger must b << 46 (const char * theCommandPath,G4UImessenger * theMessenger);
46 G4UIcmdWithAnInteger(const char* commandPa << 47 // Constructor. The command string with full path directory
47 << 48 // and the pointer to the messenger must be given.
48 // Set the parameter name. The name is use << 49 static G4int GetNewIntValue(const char* paramString);
49 // If "omittable" is set as true, the user << 50 // Convert string which represents an integer to an integer.
50 // the value when the command is applied. << 51 void SetParameterName(const char * theName,G4bool omittable,
>> 52 G4bool currentAsDefault=false);
>> 53 // Set the parameter name. The name is used by the range checking.
>> 54 // If "omittable" is set as true, the user of this command can ommit
>> 55 // the value when he/she applies the command. If "omittable" is false,
51 // the user must supply an integer value. 56 // the user must supply an integer value.
52 // "currentAsDefault" flag is valid only i << 57 // "currentAsDefault" flag is valid only if "omittable" is true. If this
53 // flag is true, the current value is used << 58 // flag is true, the current value is used as the default value when the
54 // user omits the parameter. If this flag << 59 // user ommit the parameter. If this flag is false, the value given by the
55 // the next SetDefaultValue() method is us << 60 // 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); 61 void SetDefaultValue(G4int defVal);
62 << 62 // Set the default value of the parameter. This default value is used
63 // Convert string which represents an inte << 63 // when the user of this command ommits the parameter value, and
64 static G4int GetNewIntValue(const char* pa << 64 // "ommitable" is true and "currentAsDefault" is false.
65 }; 65 };
66 66
67 #endif 67 #endif
68 68