Geant4 11.2.2
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
G4UIcmdWithADoubleAndUnit Class Reference

#include <G4UIcmdWithADoubleAndUnit.hh>

+ Inheritance diagram for G4UIcmdWithADoubleAndUnit:

Public Member Functions

 G4UIcmdWithADoubleAndUnit (const char *theCommandPath, G4UImessenger *theMessenger)
 
G4int DoIt (G4String parameterList) override
 
G4String ConvertToStringWithBestUnit (G4double val)
 
G4String ConvertToStringWithDefaultUnit (G4double val)
 
void SetParameterName (const char *theName, G4bool omittable, G4bool currentAsDefault=false)
 
void SetDefaultValue (G4double defVal)
 
void SetUnitCategory (const char *unitCategory)
 
void SetUnitCandidates (const char *candidateList)
 
void SetDefaultUnit (const char *defUnit)
 
- Public Member Functions inherited from G4UIcommand
 G4UIcommand ()=default
 
 G4UIcommand (const char *theCommandPath, G4UImessenger *theMessenger, G4bool tBB=true)
 
virtual ~G4UIcommand ()
 
G4bool operator== (const G4UIcommand &right) const
 
G4bool operator!= (const G4UIcommand &right) const
 
G4String GetCurrentValue ()
 
void AvailableForStates (G4ApplicationState s1)
 
void AvailableForStates (G4ApplicationState s1, G4ApplicationState s2)
 
void AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3)
 
void AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4)
 
void AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4, G4ApplicationState s5)
 
G4bool IsAvailable ()
 
virtual void List ()
 
void SetRange (const char *rs)
 
const G4String & GetRange () const
 
std::size_t GetGuidanceEntries () const
 
const G4String & GetGuidanceLine (G4int i) const
 
const G4String & GetCommandPath () const
 
const G4String & GetCommandName () const
 
std::size_t GetParameterEntries () const
 
G4UIparameter * GetParameter (G4int i) const
 
std::vector< G4ApplicationState > * GetStateList ()
 
G4UImessenger * GetMessenger () const
 
void SetParameter (G4UIparameter *const newParameter)
 
void SetGuidance (const char *aGuidance)
 
const G4String GetTitle () const
 
void SetToBeBroadcasted (G4bool val)
 
G4bool ToBeBroadcasted () const
 
void SetToBeFlushed (G4bool val)
 
G4bool ToBeFlushed () const
 
void SetWorkerThreadOnly (G4bool val=true)
 
G4bool IsWorkerThreadOnly () const
 
void CommandFailed (G4int errCode, G4ExceptionDescription &ed)
 
void CommandFailed (G4ExceptionDescription &ed)
 
G4int IfCommandFailed ()
 
const G4String & GetFailureDescription ()
 
void ResetFailure ()
 
CommandType GetCommandType () const
 
void SetCommandType (CommandType)
 
void SetDefaultSortFlag (G4bool val)
 

Static Public Member Functions

static G4double GetNewDoubleValue (const char *paramString)
 
static G4double GetNewDoubleRawValue (const char *paramString)
 
static G4double GetNewUnitValue (const char *paramString)
 
- Static Public Member Functions inherited from G4UIcommand
static G4String ConvertToString (G4bool boolVal)
 
static G4String ConvertToString (G4int intValue)
 
static G4String ConvertToString (G4long longValue)
 
static G4String ConvertToString (G4double doubleValue)
 
static G4String ConvertToString (G4double doubleValue, const char *unitName)
 
static G4String ConvertToString (const G4ThreeVector &vec)
 
static G4String ConvertToString (const G4ThreeVector &vec, const char *unitName)
 
static G4bool ConvertToBool (const char *st)
 
static G4int ConvertToInt (const char *st)
 
static G4long ConvertToLongInt (const char *st)
 
static G4double ConvertToDouble (const char *st)
 
static G4double ConvertToDimensionedDouble (const char *st)
 
static G4ThreeVector ConvertTo3Vector (const char *st)
 
static G4ThreeVector ConvertToDimensioned3Vector (const char *st)
 
static G4double ValueOf (const char *unitName)
 
static G4String CategoryOf (const char *unitName)
 
static G4String UnitsList (const char *unitCategory)
 

Additional Inherited Members

- Public Types inherited from G4UIcommand
enum  CommandType {
  BaseClassCmd , WithoutParameterCmd , WithABoolCmd , WithAnIntegerCmd ,
  WithALongIntCmd , WithADoubleCmd , WithADoubleAndUnitCmd , With3VectorCmd ,
  With3VectorAndUnitCmd , WithAStringCmd , CmdDirectory = -1
}
 
- Protected Types inherited from G4UIcommand
using yystype = G4UItokenNum::yystype
 
using tokenNum = G4UItokenNum::tokenNum
 
- Protected Member Functions inherited from G4UIcommand
G4int CheckNewValue (const char *newValue)
 
- Protected Attributes inherited from G4UIcommand
G4bool toBeBroadcasted = false
 
G4bool toBeFlushed = false
 
G4bool workerThreadOnly = false
 
G4int commandFailureCode = 0
 
G4String failureDescription = ""
 
G4bool ifSort = false
 

Detailed Description

Definition at line 41 of file G4UIcmdWithADoubleAndUnit.hh.

Constructor & Destructor Documentation

◆ G4UIcmdWithADoubleAndUnit()

G4UIcmdWithADoubleAndUnit::G4UIcmdWithADoubleAndUnit ( const char * theCommandPath,
G4UImessenger * theMessenger )

Definition at line 41 of file G4UIcmdWithADoubleAndUnit.cc.

43 : G4UIcommand(theCommandPath, theMessenger)
44{
45 auto* dblParam = new G4UIparameter('d');
46 SetParameter(dblParam);
47 auto* untParam = new G4UIparameter('s');
48 untParam->SetParameterName("Unit");
49 SetParameter(untParam);
50 SetCommandType(WithADoubleAndUnitCmd);
51}
G4UIcommand::G4UIcommand
G4UIcommand()=default
G4UIcommand::SetCommandType
void SetCommandType(CommandType)
Definition G4UIcommand.cc:83
G4UIcommand::SetParameter
void SetParameter(G4UIparameter *const newParameter)
Definition G4UIcommand.hh:137

Member Function Documentation

◆ ConvertToStringWithBestUnit()

G4String G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit ( G4double val)

Definition at line 121 of file G4UIcmdWithADoubleAndUnit.cc.

122{
123 G4UIparameter* unitParam = GetParameter(1);
124 G4String canList = unitParam->GetParameterCandidates();
125 G4Tokenizer candidateTokenizer(canList);
126 G4String aToken = candidateTokenizer();
127 std::ostringstream os;
128 os << G4BestUnit(val, CategoryOf(aToken));
129
130 G4String st = os.str();
131 return st;
132}
G4BestUnit
#define G4BestUnit(a, b)
Definition G4SteppingVerbose.cc:46
G4UIcommand::GetParameter
G4UIparameter * GetParameter(G4int i) const
Definition G4UIcommand.hh:129
G4UIcommand::CategoryOf
static G4String CategoryOf(const char *unitName)
Definition G4UIcommand.cc:295
G4UIparameter::GetParameterCandidates
const G4String & GetParameterCandidates() const
Definition G4UIparameter.hh:98

Referenced by ConvertToStringWithDefaultUnit(), and G4MoleculeShootMessenger::GetCurrentValue().

◆ ConvertToStringWithDefaultUnit()

G4String G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit ( G4double val)

Definition at line 135 of file G4UIcmdWithADoubleAndUnit.cc.

136{
137 G4UIparameter* unitParam = GetParameter(1);
138 G4String st;
139 if (unitParam->IsOmittable()) {
140 st = ConvertToString(val, unitParam->GetDefaultValue());
141 }
142 else {
143 st = ConvertToStringWithBestUnit(val);
144 }
145 return st;
146}
G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit
G4String ConvertToStringWithBestUnit(G4double val)
Definition G4UIcmdWithADoubleAndUnit.cc:121
G4UIcommand::ConvertToString
static G4String ConvertToString(G4bool boolVal)
Definition G4UIcommand.cc:357
G4UIparameter::IsOmittable
G4bool IsOmittable() const
Definition G4UIparameter.hh:101
G4UIparameter::GetDefaultValue
const G4String & GetDefaultValue() const
Definition G4UIparameter.hh:79

◆ DoIt()

G4int G4UIcmdWithADoubleAndUnit::DoIt ( G4String parameterList)
overridevirtual

Reimplemented from G4UIcommand.

Definition at line 54 of file G4UIcmdWithADoubleAndUnit.cc.

55{
56 std::vector<G4String> token_vector;
57 G4Tokenizer tkn(parameterList);
58 G4String str;
59 while (!(str = tkn()).empty()) {
60 token_vector.push_back(str);
61 }
62
63 // convert a value in default unit
64 G4String converted_parameter;
65 G4String default_unit = GetParameter(1)->GetDefaultValue();
66 if (!default_unit.empty() && token_vector.size() >= 2) {
67 if (CategoryOf(token_vector[1]) != CategoryOf(default_unit)) {
68 return fParameterOutOfCandidates + 1;
69 }
70 G4double value_given = ValueOf(token_vector[1]);
71 G4double value_default = ValueOf(default_unit);
72 G4double value = ConvertToDouble(token_vector[0]) * value_given / value_default;
73 // reconstruct parameter list
74 converted_parameter += ConvertToString(value);
75 converted_parameter += " ";
76 converted_parameter += default_unit;
77 for (std::size_t i = 2; i < token_vector.size(); ++i) {
78 converted_parameter += " ";
79 converted_parameter += token_vector[i];
80 }
81 }
82 else {
83 converted_parameter = parameterList;
84 }
85
86 return G4UIcommand::DoIt(converted_parameter);
87}
G4double
double G4double
Definition G4Types.hh:83
fParameterOutOfCandidates
@ fParameterOutOfCandidates
Definition G4UIcommandStatus.hh:44
G4UIcommand::ValueOf
static G4double ValueOf(const char *unitName)
Definition G4UIcommand.cc:289
G4UIcommand::DoIt
virtual G4int DoIt(G4String parameterList)
Definition G4UIcommand.cc:129
G4UIcommand::ConvertToDouble
static G4double ConvertToDouble(const char *st)
Definition G4UIcommand.cc:440

◆ GetNewDoubleRawValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewDoubleRawValue ( const char * paramString)
static

Definition at line 96 of file G4UIcmdWithADoubleAndUnit.cc.

97{
98 G4double vl;
99 char unts[30];
100
101 std::istringstream is(paramString);
102 is >> vl >> unts;
103
104 return vl;
105}

◆ GetNewDoubleValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewDoubleValue ( const char * paramString)
static

Definition at line 90 of file G4UIcmdWithADoubleAndUnit.cc.

91{
92 return ConvertToDimensionedDouble(paramString);
93}
G4UIcommand::ConvertToDimensionedDouble
static G4double ConvertToDimensionedDouble(const char *st)
Definition G4UIcommand.cc:446

Referenced by G4ModelCmdSetAuxPtsSize< M >::Apply(), G4ModelCmdSetStepPtsSize< M >::Apply(), G4AdjointSimMessenger::SetNewValue(), G4ChargeExchangeMessenger::SetNewValue(), G4EmExtraParametersMessenger::SetNewValue(), G4EmMessenger::SetNewValue(), G4EmParametersMessenger::SetNewValue(), G4ErrorMessenger::SetNewValue(), G4GeneralParticleSourceMessenger::SetNewValue(), G4GeometryMessenger::SetNewValue(), G4HadronicEPTestMessenger::SetNewValue(), G4HadronicParametersMessenger::SetNewValue(), G4INCLXXInterfaceMessenger::SetNewValue(), G4MoleculeShootMessenger::SetNewValue(), G4NeutronKillerMessenger::SetNewValue(), G4NuclideTableMessenger::SetNewValue(), G4OpenGLXmViewerMessenger::SetNewValue(), G4ParticleGunMessenger::SetNewValue(), G4ParticleHPMessenger::SetNewValue(), G4ParticlePropertyMessenger::SetNewValue(), G4ProductionCutsTableMessenger::SetNewValue(), G4QSSMessenger::SetNewValue(), G4RadioactivationMessenger::SetNewValue(), G4RadioactiveDecayMessenger::SetNewValue(), G4RTMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), G4UserPhysicsListMessenger::SetNewValue(), G4VisCommandViewerDolly::SetNewValue(), and GFlashShowerModelMessenger::SetNewValue().

◆ GetNewUnitValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewUnitValue ( const char * paramString)
static

Definition at line 108 of file G4UIcmdWithADoubleAndUnit.cc.

109{
110 G4double vl;
111 char unts[30];
112
113 std::istringstream is(paramString);
114 is >> vl >> unts;
115 G4String unt = unts;
116
117 return ValueOf(unt);
118}

Referenced by G4GeometryMessenger::SetNewValue().

◆ SetDefaultUnit()

void G4UIcmdWithADoubleAndUnit::SetDefaultUnit ( const char * defUnit)

Definition at line 180 of file G4UIcmdWithADoubleAndUnit.cc.

181{
182 G4UIparameter* untParam = GetParameter(1);
183 untParam->SetOmittable(true);
184 untParam->SetDefaultValue(defUnit);
185 SetUnitCategory(CategoryOf(defUnit));
186}
G4UIcmdWithADoubleAndUnit::SetUnitCategory
void SetUnitCategory(const char *unitCategory)
Definition G4UIcmdWithADoubleAndUnit.cc:166
G4UIparameter::SetDefaultValue
void SetDefaultValue(const char *theDefaultValue)
Definition G4UIparameter.hh:69
G4UIparameter::SetOmittable
void SetOmittable(G4bool om)
Definition G4UIparameter.hh:100

Referenced by G4ErrorMessenger::G4ErrorMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4NuclideTableMessenger::G4NuclideTableMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4QSSMessenger::G4QSSMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), and GFlashShowerModelMessenger::GFlashShowerModelMessenger().

◆ SetDefaultValue()

void G4UIcmdWithADoubleAndUnit::SetDefaultValue ( G4double defVal)

Definition at line 159 of file G4UIcmdWithADoubleAndUnit.cc.

160{
161 G4UIparameter* theParam = GetParameter(0);
162 theParam->SetDefaultValue(defVal);
163}

Referenced by G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4NuclideTableMessenger::G4NuclideTableMessenger(), G4ParticleHPMessenger::G4ParticleHPMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), and G4UserPhysicsListMessenger::G4UserPhysicsListMessenger().

◆ SetParameterName()

void G4UIcmdWithADoubleAndUnit::SetParameterName ( const char * theName,
G4bool omittable,
G4bool currentAsDefault = false )

Definition at line 149 of file G4UIcmdWithADoubleAndUnit.cc.

151{
152 G4UIparameter* theParam = GetParameter(0);
153 theParam->SetParameterName(theName);
154 theParam->SetOmittable(omittable);
155 theParam->SetCurrentAsDefault(currentAsDefault);
156}
G4UIparameter::SetParameterName
void SetParameterName(const char *pName)
Definition G4UIparameter.hh:91
G4UIparameter::SetCurrentAsDefault
void SetCurrentAsDefault(G4bool val)
Definition G4UIparameter.hh:103

Referenced by G4AdjointSimMessenger::G4AdjointSimMessenger(), G4ChargeExchangeMessenger::G4ChargeExchangeMessenger(), G4EmMessenger::G4EmMessenger(), G4EmParametersMessenger::G4EmParametersMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4HadronicParametersMessenger::G4HadronicParametersMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4ModelCmdApplyDoubleAndUnit< M >::G4ModelCmdApplyDoubleAndUnit(), G4NeutronKillerMessenger::G4NeutronKillerMessenger(), G4NuclideTableMessenger::G4NuclideTableMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticleHPMessenger::G4ParticleHPMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4QSSMessenger::G4QSSMessenger(), G4RadioactivationMessenger::G4RadioactivationMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), and GFlashShowerModelMessenger::GFlashShowerModelMessenger().

◆ SetUnitCandidates()

void G4UIcmdWithADoubleAndUnit::SetUnitCandidates ( const char * candidateList)

Definition at line 172 of file G4UIcmdWithADoubleAndUnit.cc.

173{
174 G4UIparameter* untParam = GetParameter(1);
175 G4String canList = candidateList;
176 untParam->SetParameterCandidates(canList);
177}
G4UIparameter::SetParameterCandidates
void SetParameterCandidates(const char *theString)
Definition G4UIparameter.hh:96

Referenced by SetUnitCategory().

◆ SetUnitCategory()

void G4UIcmdWithADoubleAndUnit::SetUnitCategory ( const char * unitCategory)

Definition at line 166 of file G4UIcmdWithADoubleAndUnit.cc.

167{
168 SetUnitCandidates(UnitsList(unitCategory));
169}
G4UIcmdWithADoubleAndUnit::SetUnitCandidates
void SetUnitCandidates(const char *candidateList)
Definition G4UIcmdWithADoubleAndUnit.cc:172
G4UIcommand::UnitsList
static G4String UnitsList(const char *unitCategory)
Definition G4UIcommand.cc:301

Referenced by G4AdjointSimMessenger::G4AdjointSimMessenger(), G4ChargeExchangeMessenger::G4ChargeExchangeMessenger(), G4EmMessenger::G4EmMessenger(), G4EmParametersMessenger::G4EmParametersMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4HadronicParametersMessenger::G4HadronicParametersMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4ModelCmdSetTimeSliceInterval< M >::G4ModelCmdSetTimeSliceInterval(), G4NeutronKillerMessenger::G4NeutronKillerMessenger(), G4ParticleHPMessenger::G4ParticleHPMessenger(), G4QSSMessenger::G4QSSMessenger(), G4RadioactivationMessenger::G4RadioactivationMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), GFlashShowerModelMessenger::GFlashShowerModelMessenger(), and SetDefaultUnit().

The documentation for this class was generated from the following files: