ECCE @ EIC Software
Reference for
ECCE @ EIC
simulation and reconstruction software on GitHub
Home page
Related Pages
Modules
Namespaces
Classes
Files
External Links
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
G4UIcmdWithADoubleAndUnit.hh
Go to the documentation of this file.
Or view
the newest version in sPHENIX GitHub for file G4UIcmdWithADoubleAndUnit.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
//
27
//
28
//
29
30
#ifndef G4UIcmdWithADoubleAndUnit_H
31
#define G4UIcmdWithADoubleAndUnit_H 1
32
33
#include "
G4UIcommand.hh
"
34
35
// class description:
36
// A concrete class of G4UIcommand. The command defined by this class
37
// takes a double value and a unit string.
38
// General information of G4UIcommand is given in G4UIcommand.hh.
39
40
class
G4UIcmdWithADoubleAndUnit
:
public
G4UIcommand
41
{
42
public
:
// with description
43
G4UIcmdWithADoubleAndUnit
44
(
const
char
* theCommandPath,
G4UImessenger
* theMessenger);
45
// Constructor. The command string with full path directory
46
// and the pointer to the messenger must be given.
47
virtual
G4int
DoIt
(
G4String
parameterList);
48
static
G4double
GetNewDoubleValue
(
const
char
* paramString);
49
// Convert string which represents a double value and a unit to
50
// double. Value is converted to the Geant4 internal unit.
51
static
G4double
GetNewDoubleRawValue
(
const
char
* paramString);
52
// Convert string which represents a double value and a unit to
53
// double. Value is NOT converted to the Geant4 internal unit
54
// but just as the given string.
55
static
G4double
GetNewUnitValue
(
const
char
* paramString);
56
// Convert the unit string to the value of the unit. "paramString"
57
// must contain a double value AND a unit string.
58
G4String
ConvertToStringWithBestUnit
(
G4double
val);
59
// Convert a double value to a string of digits and unit. Best unit is
60
// chosen from the unit category of default unit (in case SetDefaultUnit()
61
// is defined) or category defined by SetUnitCategory().
62
G4String
ConvertToStringWithDefaultUnit
(
G4double
val);
63
// Convert a double value to a string of digits and unit. Best unit is
64
// chosen from the category defined by SetUnitCategory() in case default
65
// unit is not defined.
66
void
SetParameterName
(
const
char
* theName,
G4bool
omittable,
67
G4bool
currentAsDefault=
false
);
68
// Set the parameter name for double parameterxs. Name is used by
69
// the range checking routine.
70
// If "omittable" is set as true, the user of this command can ommit
71
// the value when he/she applies the command. If "omittable" is false,
72
// the user must supply a value.
73
// "currentAsDefault" flag is valid only if "omittable" is true. If this
74
// flag is true, the current value is used as the default value when the
75
// user ommit the double parameter. If this flag is false, the value
76
// given by the next SetDefaultValue() method is used.
77
void
SetDefaultValue
(
G4double
defVal);
78
// Set the default value of the parameter. This default value is used
79
// when the user of this command ommits the parameter value, and
80
// "ommitable" is true and "curreutAsDefault" is false.
81
void
SetUnitCategory
(
const
char
* unitCategory);
82
void
SetUnitCandidates
(
const
char
* candidateList);
83
void
SetDefaultUnit
(
const
char
* defUnit);
84
// These three methods must be used alternatively.
85
// The user cannot ommit the unit as the second parameter of the command if
86
// SetUnitCategory() or SetUnitCandidates() is used, while the unit defined
87
// by SetDefaultUnit() method is used as the default unit so that the user can
88
// ommits the second parameter.
89
// SetUnitCategory() defines the category of the units which will be accepted.
90
// The available categories can be found in G4SystemOfUnits.hh in global category.
91
// Only the units categorized in the given category are accepted as the second
92
// parameter of the command.
93
// SetUnitCandidates() defines the candidates of units. Units listed in the
94
// argument of this method must be separated by space(s). Only the units listed
95
// in the candidate list are accepted as the second parameter of the command.
96
// SetDefaultUnit() defines the default unit and also it defines the category
97
// of the allowed units. Thus only the units categorized as the given default
98
// unit will be accepted.
99
};
100
101
#endif
geant4
tree
geant4-10.6-release
source
intercoms
include
G4UIcmdWithADoubleAndUnit.hh
Built by
Jin Huang
. updated:
Wed Jun 29 2022 17:25:21
using
1.8.2 with
ECCE GitHub integration