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
G4UIcmdWithAnInteger Class Reference

#include <G4UIcmdWithAnInteger.hh>

+ Inheritance diagram for G4UIcmdWithAnInteger:

Public Member Functions

 G4UIcmdWithAnInteger (const char *commandPath, G4UImessenger *messenger)
 
void SetParameterName (const char *theName, G4bool omittable, G4bool currentAsDefault=false)
 
void SetDefaultValue (G4int defVal)
 
- 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
 
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
 
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 G4int GetNewIntValue (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 G4UIcmdWithAnInteger.hh.

Constructor & Destructor Documentation

◆ G4UIcmdWithAnInteger()

G4UIcmdWithAnInteger::G4UIcmdWithAnInteger ( const char * commandPath,
G4UImessenger * messenger )

Definition at line 34 of file G4UIcmdWithAnInteger.cc.

35 : G4UIcommand(theCommandPath, theMessenger)
36{
37 auto* intParam = new G4UIparameter('i');
38 SetParameter(intParam);
39 SetCommandType(WithAnIntegerCmd);
40}
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

◆ GetNewIntValue()

G4int G4UIcmdWithAnInteger::GetNewIntValue ( const char * paramString)
static

Definition at line 43 of file G4UIcmdWithAnInteger.cc.

44{
45 return ConvertToInt(paramString);
46}
G4UIcommand::ConvertToInt
static G4int ConvertToInt(const char *st)
Definition G4UIcommand.cc:428

Referenced by G4AdjointSimMessenger::SetNewValue(), G4ASCIITreeMessenger::SetNewValue(), G4DecayTableMessenger::SetNewValue(), G4DeexParametersMessenger::SetNewValue(), G4DMmessenger::SetNewValue(), G4EmParametersMessenger::SetNewValue(), G4EvManMessenger::SetNewValue(), G4FTFTuningsMessenger::SetNewValue(), G4GeneralParticleSourceMessenger::SetNewValue(), G4GeometryMessenger::SetNewValue(), G4GlobalMagFieldMessenger::SetNewValue(), G4HadronicEPTestMessenger::SetNewValue(), G4HadronicParametersMessenger::SetNewValue(), G4INCLXXInterfaceMessenger::SetNewValue(), G4MoleculeShootMessenger::SetNewValue(), G4NistMessenger::SetNewValue(), G4OpenInventorXtExaminerViewerMessenger::SetNewValue(), G4OpticalParametersMessenger::SetNewValue(), G4ParticleGunMessenger::SetNewValue(), G4ParticleMessenger::SetNewValue(), G4ParticlePropertyMessenger::SetNewValue(), G4PersistencyCenterMessenger::SetNewValue(), G4PolarizationMessenger::SetNewValue(), G4ProcessManagerMessenger::SetNewValue(), G4ProcessTableMessenger::SetNewValue(), G4ProductionCutsTableMessenger::SetNewValue(), G4RadioactivationMessenger::SetNewValue(), G4RadioactiveDecayMessenger::SetNewValue(), G4RTMessenger::SetNewValue(), G4RunMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), G4SDmessenger::SetNewValue(), G4StackingMessenger::SetNewValue(), G4tgrMessenger::SetNewValue(), G4UCNBoundaryProcessMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4UserPhysicsListMessenger::SetNewValue(), G4VisCommandSetArrow3DLineSegmentsPerCircle::SetNewValue(), G4VITSteppingVerbose::SetNewValue(), and GFlashShowerModelMessenger::SetNewValue().

◆ SetDefaultValue()

void G4UIcmdWithAnInteger::SetDefaultValue ( G4int defVal)

Definition at line 59 of file G4UIcmdWithAnInteger.cc.

60{
61 G4UIparameter* theParam = GetParameter(0);
62 theParam->SetDefaultValue(defVal);
63}
G4UIcommand::GetParameter
G4UIparameter * GetParameter(G4int i) const
Definition G4UIcommand.hh:129
G4UIparameter::SetDefaultValue
void SetDefaultValue(const char *theDefaultValue)
Definition G4UIparameter.hh:69

Referenced by G4DecayTableMessenger::G4DecayTableMessenger(), G4DeexParametersMessenger::G4DeexParametersMessenger(), G4EmParametersMessenger::G4EmParametersMessenger(), G4FTFTuningsMessenger::G4FTFTuningsMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4HadronicParametersMessenger::G4HadronicParametersMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4LocalThreadCoutMessenger::G4LocalThreadCoutMessenger(), G4NistMessenger::G4NistMessenger(), G4OpticalParametersMessenger::G4OpticalParametersMessenger(), G4ParticleHPMessenger::G4ParticleHPMessenger(), G4ParticleMessenger::G4ParticleMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4PersistencyCenterMessenger::G4PersistencyCenterMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4RadioactivationMessenger::G4RadioactivationMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4RunMessenger::G4RunMessenger(), G4StackingMessenger::G4StackingMessenger(), G4TrackingMessenger::G4TrackingMessenger(), G4UCNBoundaryProcessMessenger::G4UCNBoundaryProcessMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandSetArrow3DLineSegmentsPerCircle::G4VisCommandSetArrow3DLineSegmentsPerCircle(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), and G4VisCommandsViewerSet::G4VisCommandsViewerSet().

◆ SetParameterName()

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

Definition at line 49 of file G4UIcmdWithAnInteger.cc.

51{
52 G4UIparameter* theParam = GetParameter(0);
53 theParam->SetParameterName(theName);
54 theParam->SetOmittable(omittable);
55 theParam->SetCurrentAsDefault(currentAsDefault);
56}
G4UIparameter::SetParameterName
void SetParameterName(const char *pName)
Definition G4UIparameter.hh:91
G4UIparameter::SetOmittable
void SetOmittable(G4bool om)
Definition G4UIparameter.hh:100
G4UIparameter::SetCurrentAsDefault
void SetCurrentAsDefault(G4bool val)
Definition G4UIparameter.hh:103

Referenced by G4AdjointSimMessenger::G4AdjointSimMessenger(), G4DecayTableMessenger::G4DecayTableMessenger(), G4DeexParametersMessenger::G4DeexParametersMessenger(), G4DMmessenger::G4DMmessenger(), G4EmParametersMessenger::G4EmParametersMessenger(), G4EvManMessenger::G4EvManMessenger(), G4FTFTuningsMessenger::G4FTFTuningsMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4HadronicParametersMessenger::G4HadronicParametersMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4LocalThreadCoutMessenger::G4LocalThreadCoutMessenger(), G4ModelCmdApplyInteger< M >::G4ModelCmdApplyInteger(), G4NistMessenger::G4NistMessenger(), G4OpticalParametersMessenger::G4OpticalParametersMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticleHPMessenger::G4ParticleHPMessenger(), G4ParticleMessenger::G4ParticleMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4PersistencyCenterMessenger::G4PersistencyCenterMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4RadioactivationMessenger::G4RadioactivationMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4RunMessenger::G4RunMessenger(), G4SDmessenger::G4SDmessenger(), G4StackingMessenger::G4StackingMessenger(), G4tgrMessenger::G4tgrMessenger(), G4TrackingMessenger::G4TrackingMessenger(), G4UCNBoundaryProcessMessenger::G4UCNBoundaryProcessMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandSetArrow3DLineSegmentsPerCircle::G4VisCommandSetArrow3DLineSegmentsPerCircle(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and GFlashShowerModelMessenger::GFlashShowerModelMessenger().

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