ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4UIcmdWithNucleusLimits.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4UIcmdWithNucleusLimits.hh
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 #ifndef G4UIcmdWithNucleusLimits_h
27 #define G4UIcmdWithNucleusLimits_h 1
28 // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29 //
30 // MODULE: G4UIcmdWithNucleusAndUnit.hh
31 //
32 // Version: 0.b.4
33 // Date: 14/04/00
34 // Author: F Lei & P R Truscott
35 // Organisation: DERA UK
36 // Customer: ESA/ESTEC, NOORDWIJK
37 // Contract: 12115/96/JG/NL Work Order No. 3
38 //
39 // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40 //
41 // Class Description
42 //
43 // The G4UIcmdWithNucleusLimits permits input of the range of nuclides
44 // that will be treated in the G4RadioactiveDecay Class. Input is expected in
45 // the form:
46 //
47 // AMin AMax ZMin ZMax
48 //
49 // where AMin, AMax, ZMin, ZMax are respectively the upper and lower limits
50 // in A (atomic mass), and the upper and lower limits in Z (atomic number)
51 // which define the range of nuclides treated by the G4RadioactiveDecay.
52 //
53 // Class Description - end:
54 //
55 // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
56 //
57 // CHANGE HISTORY
58 // --------------
59 //
60 // 29 February 2000, P R Truscott, DERA UK
61 // 0.b.3 release.
62 //
63 //
64 // 13 April 2000, F Lei, DERA UK
65 // 0.b.4 release. No change to this file
66 //
67 // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
69 //
70 #include "G4UIcommand.hh"
71 #include "globals.hh"
72 
73 #include "G4NucleusLimits.hh"
75 //
77 {
78 public: // With description
80  (const char * theCommandPath,G4UImessenger * theMessenger);
81  // Constructor identifying the command path in the User Interface and the
82  // associated G4UImessenger which will use this G4UIcommand object.
83  //
85  // Destructor
86  //
88  // Extracts the values aMin, aMax, zMin, zMax from paramString.
89  // Values returned have aMin, aMax, zMin, and zMax (within the
90  // G4NucleusLimits variable).
92  // Converts the G4NucleusLimits defined by vec into a G4String.
93  void SetParameterName(const char * theNameAMin,const char * theNameAMax,
94  const char * theNameZMin, const char * theNameZMax,
95  G4bool omittable, G4bool currentAsDefault=true);
96  // Identifies the parameter names associated with each of the G4doubles
97  // used to define the G4NucleusLimits variable.
98  void SetDefaultValue(G4NucleusLimits defVal);
99  // Sets the default G4NucleusLimits if the command is invoked without any
100  // parameters.
101 };
103 #endif
104