Geant4 11.1.1
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
G4UIcmdWithABool Class Reference

#include <G4UIcmdWithABool.hh>

+ Inheritance diagram for G4UIcmdWithABool:

Public Member Functions

 G4UIcmdWithABool (const char *theCommandPath, G4UImessenger *theMessenger)
 
void SetParameterName (const char *theName, G4bool omittable, G4bool currentAsDefault=false)
 
void SetDefaultValue (G4bool 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 G4bool GetNewBoolValue (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 45 of file G4UIcmdWithABool.hh.

Constructor & Destructor Documentation

◆ G4UIcmdWithABool()

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

Definition at line 34 of file G4UIcmdWithABool.cc.

36 : G4UIcommand(theCommandPath, theMessenger)
37{
38 auto* blParam = new G4UIparameter('b');
39 SetParameter(blParam);
40 SetCommandType(WithABoolCmd);
41}
G4UIcommand::G4UIcommand
G4UIcommand()=default
G4UIcommand::SetCommandType
void SetCommandType(CommandType)
Definition: G4UIcommand.cc:89
G4UIcommand::SetParameter
void SetParameter(G4UIparameter *const newParameter)
Definition: G4UIcommand.hh:147

Member Function Documentation

◆ GetNewBoolValue()

G4bool G4UIcmdWithABool::GetNewBoolValue ( const char *  paramString)
static

Definition at line 44 of file G4UIcmdWithABool.cc.

45{
46 return ConvertToBool(paramString);
47}
G4UIcommand::ConvertToBool
static G4bool ConvertToBool(const char *st)
Definition: G4UIcommand.cc:549

Referenced by G4GDMLMessenger::SetNewValue(), G4OpticalParametersMessenger::SetNewValue(), G4UCNBoundaryProcessMessenger::SetNewValue(), G4ProfilerMessenger::SetNewValue(), G4DNAChemistryManager::SetNewValue(), G4EmExtraParametersMessenger::SetNewValue(), G4EmLowEParametersMessenger::SetNewValue(), G4EmParametersMessenger::SetNewValue(), G4DeexParametersMessenger::SetNewValue(), G4EmMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4HepRepMessenger::SetNewValue(), G4VisCommandsTouchable::SetNewValue(), G4RTMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4GeometryMessenger::SetNewValue(), G4ParticlePropertyMessenger::SetNewValue(), G4RadioactivationMessenger::SetNewValue(), G4RadioactiveDecayMessenger::SetNewValue(), G4RunMessenger::SetNewValue(), G4GeneralParticleSourceMessenger::SetNewValue(), G4PolarizationMessenger::SetNewValue(), and G4HadronicParametersMessenger::SetNewValue().

◆ SetDefaultValue()

void G4UIcmdWithABool::SetDefaultValue ( G4bool  defVal)

Definition at line 60 of file G4UIcmdWithABool.cc.

61{
62 G4UIparameter* theParam = GetParameter(0);
63 theParam->SetDefaultValue(static_cast<G4int>(defVal));
64}
G4int
int G4int
Definition: G4Types.hh:85
G4UIcommand::GetParameter
G4UIparameter * GetParameter(G4int i) const
Definition: G4UIcommand.hh:140
G4UIparameter::SetDefaultValue
void SetDefaultValue(const char *theDefaultValue)
Definition: G4UIparameter.hh:70

Referenced by G4DeexParametersMessenger::G4DeexParametersMessenger(), G4EmLowEParametersMessenger::G4EmLowEParametersMessenger(), G4EmParametersMessenger::G4EmParametersMessenger(), G4GDMLMessenger::G4GDMLMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4GMocrenMessenger::G4GMocrenMessenger(), G4HadronicParametersMessenger::G4HadronicParametersMessenger(), G4LocalThreadCoutMessenger::G4LocalThreadCoutMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4OpticalParametersMessenger::G4OpticalParametersMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4RadioactivationMessenger::G4RadioactivationMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4RunMessenger::G4RunMessenger(), G4UCNBoundaryProcessMessenger::G4UCNBoundaryProcessMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4VisCommandsTouchable::G4VisCommandsTouchable(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and G4VisCommandViewerDefaultHiddenEdge::G4VisCommandViewerDefaultHiddenEdge().

◆ SetParameterName()

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

Definition at line 50 of file G4UIcmdWithABool.cc.

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

Referenced by G4DeexParametersMessenger::G4DeexParametersMessenger(), G4EmLowEParametersMessenger::G4EmLowEParametersMessenger(), G4EmParametersMessenger::G4EmParametersMessenger(), G4GDMLMessenger::G4GDMLMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4GMocrenMessenger::G4GMocrenMessenger(), G4HadronicParametersMessenger::G4HadronicParametersMessenger(), G4LocalThreadCoutMessenger::G4LocalThreadCoutMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ModelCmdApplyBool< M >::G4ModelCmdApplyBool(), G4OpticalParametersMessenger::G4OpticalParametersMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4RadioactivationMessenger::G4RadioactivationMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4RunMessenger::G4RunMessenger(), G4UCNBoundaryProcessMessenger::G4UCNBoundaryProcessMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4VisCommandsTouchable::G4VisCommandsTouchable(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and G4VisCommandViewerDefaultHiddenEdge::G4VisCommandViewerDefaultHiddenEdge().

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