Geant4 9.6.0
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)
 
virtual G4int DoIt (G4String parameterList)
 
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 ()
 
 G4UIcommand (const char *theCommandPath, G4UImessenger *theMessenger)
 
virtual ~G4UIcommand ()
 
G4int operator== (const G4UIcommand &right) const
 
G4int operator!= (const G4UIcommand &right) const
 
virtual G4int DoIt (G4String parameterList)
 
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
 
G4int GetGuidanceEntries () const
 
const G4String & GetGuidanceLine (G4int i) const
 
const G4String & GetCommandPath () const
 
const G4String & GetCommandName () const
 
G4int 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
 

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 (G4double doubleValue)
 
static G4String ConvertToString (G4double doubleValue, const char *unitName)
 
static G4String ConvertToString (G4ThreeVector vec)
 
static G4String ConvertToString (G4ThreeVector vec, const char *unitName)
 
static G4bool ConvertToBool (const char *st)
 
static G4int ConvertToInt (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

- Protected Member Functions inherited from G4UIcommand
G4int CheckNewValue (const char *newValue)
 

Detailed Description

Definition at line 41 of file G4UIcmdWithADoubleAndUnit.hh.

Constructor & Destructor Documentation

◆ G4UIcmdWithADoubleAndUnit()

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

Definition at line 37 of file G4UIcmdWithADoubleAndUnit.cc.

39:G4UIcommand(theCommandPath,theMessenger)
40{
41 G4UIparameter * dblParam = new G4UIparameter('d');
42 SetParameter(dblParam);
43 G4UIparameter * untParam = new G4UIparameter('s');
44 SetParameter(untParam);
45 untParam->SetParameterName("Unit");
46}
G4UIcommand::SetParameter
void SetParameter(G4UIparameter *const newParameter)
Definition: G4UIcommand.hh:147
G4UIparameter::SetParameterName
void SetParameterName(const char *theName)
Definition: G4UIparameter.hh:107

Member Function Documentation

◆ ConvertToStringWithBestUnit()

G4String G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit ( G4double  val)

Definition at line 108 of file G4UIcmdWithADoubleAndUnit.cc.

109{
110 G4UIparameter* unitParam = GetParameter(1);
111 G4String canList = unitParam->GetParameterCandidates();
112 G4Tokenizer candidateTokenizer(canList);
113 G4String aToken = candidateTokenizer();
114 std::ostringstream os;
115 os << G4BestUnit(val,CategoryOf(aToken));
116
117 G4String st = os.str();
118 return st;
119}
G4BestUnit
#define G4BestUnit(a, b)
#define G4_USE_G4BESTUNIT_FOR_VERBOSE 1
Definition: G4SteppingVerbose.cc:53
G4UIcommand::GetParameter
G4UIparameter * GetParameter(G4int i) const
Definition: G4UIcommand.hh:140
G4UIcommand::CategoryOf
static G4String CategoryOf(const char *unitName)
Definition: G4UIcommand.cc:295
G4UIparameter::GetParameterCandidates
G4String GetParameterCandidates() const
Definition: G4UIparameter.hh:118

Referenced by ConvertToStringWithDefaultUnit().

◆ ConvertToStringWithDefaultUnit()

G4String G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit ( G4double  val)

Definition at line 121 of file G4UIcmdWithADoubleAndUnit.cc.

122{
123 G4UIparameter* unitParam = GetParameter(1);
124 G4String st;
125 if(unitParam->IsOmittable())
126 { st = ConvertToString(val,unitParam->GetDefaultValue()); }
127 else
128 { st = ConvertToStringWithBestUnit(val); }
129 return st;
130}
G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit
G4String ConvertToStringWithBestUnit(G4double val)
Definition: G4UIcmdWithADoubleAndUnit.cc:108
G4UIcommand::ConvertToString
static G4String ConvertToString(G4bool boolVal)
Definition: G4UIcommand.cc:349
G4UIparameter::GetDefaultValue
G4String GetDefaultValue() const
Definition: G4UIparameter.hh:89
G4UIparameter::IsOmittable
G4bool IsOmittable() const
Definition: G4UIparameter.hh:124

◆ DoIt()

G4int G4UIcmdWithADoubleAndUnit::DoIt ( G4String  parameterList)
virtual

Reimplemented from G4UIcommand.

Definition at line 48 of file G4UIcmdWithADoubleAndUnit.cc.

49{
50 std::vector<G4String> token_vector;
51 G4Tokenizer tkn(parameterList);
52 G4String str;
53 while( (str = tkn()) != "" ) {
54 token_vector.push_back(str);
55 }
56
57 // convert a value in default unit
58 G4String converted_parameter;
59 G4String default_unit = GetParameter(1)-> GetDefaultValue();
60 if (default_unit != "" && token_vector.size() >= 2) {
61 G4double value_given = ValueOf(token_vector[1]);
62 G4double value_default = ValueOf(default_unit);
63 G4double value = ConvertToDouble(token_vector[0])
64 * value_given / value_default;
65 // reconstruct parameter list
66 converted_parameter += ConvertToString(value);
67 converted_parameter += " ";
68 converted_parameter += default_unit;
69 for ( size_t i=2 ; i< token_vector.size(); i++) {
70 converted_parameter += " ";
71 converted_parameter += token_vector[i];
72 }
73 } else {
74 converted_parameter = parameterList;
75 }
76
77 return G4UIcommand::DoIt(converted_parameter);
78}
G4double
double G4double
Definition: G4Types.hh:64
G4UIcommand::ValueOf
static G4double ValueOf(const char *unitName)
Definition: G4UIcommand.cc:288
G4UIcommand::DoIt
virtual G4int DoIt(G4String parameterList)
Definition: G4UIcommand.cc:104
G4UIcommand::ConvertToDouble
static G4double ConvertToDouble(const char *st)
Definition: G4UIcommand.cc:421

◆ GetNewDoubleRawValue()

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

Definition at line 85 of file G4UIcmdWithADoubleAndUnit.cc.

86{
87 G4double vl;
88 char unts[30];
89
90 std::istringstream is(paramString);
91 is >> vl >> unts;
92
93 return vl;
94}

◆ GetNewDoubleValue()

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

Definition at line 80 of file G4UIcmdWithADoubleAndUnit.cc.

81{
82 return ConvertToDimensionedDouble(paramString);
83}
G4UIcommand::ConvertToDimensionedDouble
static G4double ConvertToDimensionedDouble(const char *st)
Definition: G4UIcommand.cc:429

Referenced by G4ModelCmdSetAuxPtsSize< M >::Apply(), G4ModelCmdSetStepPtsSize< M >::Apply(), G4ErrorMessenger::SetNewValue(), G4EnergyLossMessenger::SetNewValue(), G4NeutronKillerMessenger::SetNewValue(), G4AdjointSimMessenger::SetNewValue(), G4VisCommandViewerDolly::SetNewValue(), G4RTMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), G4GeneralParticleSourceMessenger::SetNewValue(), G4ParticleGunMessenger::SetNewValue(), G4GeometryMessenger::SetNewValue(), GFlashShowerModelMessenger::SetNewValue(), G4ParticlePropertyMessenger::SetNewValue(), G4ProductionCutsTableMessenger::SetNewValue(), G4HadronicEPTestMessenger::SetNewValue(), G4RadioactiveDecaymessenger::SetNewValue(), and G4UserPhysicsListMessenger::SetNewValue().

◆ GetNewUnitValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewUnitValue ( 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 G4String unt = unts;
104
105 return ValueOf(unt);
106}

◆ SetDefaultUnit()

void G4UIcmdWithADoubleAndUnit::SetDefaultUnit ( const char *  defUnit)

Definition at line 159 of file G4UIcmdWithADoubleAndUnit.cc.

160{
161 G4UIparameter * untParam = GetParameter(1);
162 untParam->SetOmittable(true);
163 untParam->SetDefaultValue(defUnit);
164 SetUnitCategory(CategoryOf(defUnit));
165}
G4UIcmdWithADoubleAndUnit::SetUnitCategory
void SetUnitCategory(const char *unitCategory)
Definition: G4UIcmdWithADoubleAndUnit.cc:147
G4UIparameter::SetDefaultValue
void SetDefaultValue(const char *theDefaultValue)
Definition: G4UIparameter.hh:83
G4UIparameter::SetOmittable
void SetOmittable(G4bool om)
Definition: G4UIparameter.hh:122

Referenced by G4ErrorMessenger::G4ErrorMessenger(), G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), GFlashShowerModelMessenger::GFlashShowerModelMessenger(), and G4GenericMessenger::Command::SetUnit().

◆ SetDefaultValue()

void G4UIcmdWithADoubleAndUnit::SetDefaultValue ( G4double  defVal)

Definition at line 141 of file G4UIcmdWithADoubleAndUnit.cc.

142{
143 G4UIparameter * theParam = GetParameter(0);
144 theParam->SetDefaultValue(defVal);
145}

Referenced by G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), and G4UserPhysicsListMessenger::G4UserPhysicsListMessenger().

◆ SetParameterName()

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

Definition at line 132 of file G4UIcmdWithADoubleAndUnit.cc.

134{
135 G4UIparameter * theParam = GetParameter(0);
136 theParam->SetParameterName(theName);
137 theParam->SetOmittable(omittable);
138 theParam->SetCurrentAsDefault(currentAsDefault);
139}
G4UIparameter::SetCurrentAsDefault
void SetCurrentAsDefault(G4bool val)
Definition: G4UIparameter.hh:128

Referenced by G4AdjointSimMessenger::G4AdjointSimMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4ModelCmdApplyDoubleAndUnit< M >::G4ModelCmdApplyDoubleAndUnit(), G4NeutronKillerMessenger::G4NeutronKillerMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), and GFlashShowerModelMessenger::GFlashShowerModelMessenger().

◆ SetUnitCandidates()

void G4UIcmdWithADoubleAndUnit::SetUnitCandidates ( const char *  candidateList)

Definition at line 152 of file G4UIcmdWithADoubleAndUnit.cc.

153{
154 G4UIparameter * untParam = GetParameter(1);
155 G4String canList = candidateList;
156 untParam->SetParameterCandidates(canList);
157}
G4UIparameter::SetParameterCandidates
void SetParameterCandidates(const char *theString)
Definition: G4UIparameter.hh:113

Referenced by SetUnitCategory().

◆ SetUnitCategory()

void G4UIcmdWithADoubleAndUnit::SetUnitCategory ( const char *  unitCategory)

Definition at line 147 of file G4UIcmdWithADoubleAndUnit.cc.

148{
149 SetUnitCandidates(UnitsList(unitCategory));
150}
G4UIcmdWithADoubleAndUnit::SetUnitCandidates
void SetUnitCandidates(const char *candidateList)
Definition: G4UIcmdWithADoubleAndUnit.cc:152
G4UIcommand::UnitsList
static G4String UnitsList(const char *unitCategory)
Definition: G4UIcommand.cc:300

Referenced by G4AdjointSimMessenger::G4AdjointSimMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4ModelCmdSetTimeSliceInterval< M >::G4ModelCmdSetTimeSliceInterval(), G4NeutronKillerMessenger::G4NeutronKillerMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), GFlashShowerModelMessenger::GFlashShowerModelMessenger(), SetDefaultUnit(), and G4GenericMessenger::Command::SetUnit().

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