ExtMessenger Class Reference

Define the mechanism by which the user can communicate with the geant4e extrapolator using geant4 UI commands. More...

#include <ExtMessenger.h>

Inheritance diagram for ExtMessenger:

Collaboration diagram for ExtMessenger:

Public Member Functions
	ExtMessenger (ExtStepLengthLimitProcess *, ExtMagFieldLimitProcess *, ExtEnergyLoss *)
	constructor
	~ExtMessenger ()
	destructor
void	SetNewValue (G4UIcommand *, G4String)
	Process a geant4 UI command.

Private Attributes
ExtStepLengthLimitProcess *	m_stepLengthAction
	Process that limits the geant4e step length.
ExtMagFieldLimitProcess *	m_magFieldAction
	Process that limits the geant4e step length in magnetic field.
ExtEnergyLoss *	m_energyLossAction
	Process that limits the geant4e step length due to energy loss.
G4UIdirectory *	m_dir
	Defines UI directory for "/geant4e/" commands.
G4UIdirectory *	m_dirLimits
	Defines UI directory for "/geant4e/limits/" commands.
G4UIcmdWithADoubleAndUnit *	m_stepLengthLimitCmd
	Defines UI command "/geant4e/limits/stepLength" to limit step length.
G4UIcmdWithADouble *	m_magFieldLimitCmd
	Defines UI command "/geant4e/limits/magField" to limit step length.
G4UIcmdWithADouble *	m_energyLossCmd
	defines UI command "/geant4e/limits/energyLoss" to limit step length

Detailed Description

Define the mechanism by which the user can communicate with the geant4e extrapolator using geant4 UI commands.

Definition at line 36 of file ExtMessenger.h.

Constructor & Destructor Documentation

ExtMessenger()

ExtMessenger	(	ExtStepLengthLimitProcess *	lAct,
		ExtMagFieldLimitProcess *	mAct,
		ExtEnergyLoss *	eAct
	)

constructor

Definition at line 24 of file ExtMessenger.cc.

                                                                                                              :
  m_stepLengthAction(lAct),
  m_magFieldAction(mAct),
  m_energyLossAction(eAct)
{
 
  m_dir = new G4UIdirectory("/geant4e/");
  m_dir->SetGuidance("GEANT4e control commands");
  m_dirLimits = new G4UIdirectory("/geant4e/limits/");
  m_dirLimits->SetGuidance("GEANT4e commands to limit the step");
 
  m_stepLengthLimitCmd = new G4UIcmdWithADoubleAndUnit("/geant4e/limits/stepLength", this);
  m_stepLengthLimitCmd->SetGuidance("Limit the length of a step (distance)");
  m_stepLengthLimitCmd->SetDefaultUnit("mm");
  m_stepLengthLimitCmd->AvailableForStates(G4State_PreInit, G4State_Idle, G4State_GeomClosed, G4State_EventProc);
 
  m_magFieldLimitCmd = new G4UIcmdWithADouble("/geant4e/limits/magField", this);
  m_magFieldLimitCmd->SetGuidance("Limit the length of a step (field/momentum)");
  m_magFieldLimitCmd->AvailableForStates(G4State_PreInit, G4State_Idle, G4State_GeomClosed, G4State_EventProc);
 
  m_energyLossCmd = new G4UIcmdWithADouble("/geant4e/limits/energyLoss", this);
  m_energyLossCmd->SetGuidance("Limit the length of a step (fractional KE loss)");
  m_energyLossCmd->AvailableForStates(G4State_PreInit, G4State_Idle, G4State_GeomClosed, G4State_EventProc);
 
  if (false) {
    G4UIcommand* command = nullptr;
    SetNewValue(command, G4String(""));
  }
 
}

~ExtMessenger()

~ExtMessenger

(

)

destructor

Definition at line 55 of file ExtMessenger.cc.

{
  delete m_stepLengthLimitCmd;
  delete m_magFieldLimitCmd;
  delete m_energyLossCmd;
  delete m_dir;
  delete m_dirLimits;
}

Member Function Documentation

SetNewValue()

void SetNewValue	(	G4UIcommand *	command,
		G4String	newValue
	)

Process a geant4 UI command.

Definition at line 64 of file ExtMessenger.cc.

{
  if (command == m_stepLengthLimitCmd) {
    B2DEBUG(200, "ExtMessenger::SetNewValue() StepLengthAction SetStepLimit "
            << m_stepLengthLimitCmd->GetNewDoubleValue(newValue));
    m_stepLengthAction->SetStepLimit(m_stepLengthLimitCmd->GetNewDoubleValue(newValue));
  } else if (command == m_magFieldLimitCmd) {
    B2DEBUG(200, "ExtMessenger::SetNewValue() MagFieldAction SetStepLimit "
            << m_magFieldLimitCmd->GetNewDoubleValue(newValue));
    m_magFieldAction->SetStepLimit(m_magFieldLimitCmd->GetNewDoubleValue(newValue));
  } else if (command == m_energyLossCmd) {
    B2DEBUG(200, "ExtMessenger::SetNewValue() EnergyLossAction SetStepLimit "
            << m_energyLossCmd->GetNewDoubleValue(newValue));
    m_energyLossAction->SetStepLimit(m_energyLossCmd->GetNewDoubleValue(newValue));
  }
}

Member Data Documentation

m_dir

G4UIdirectory* m_dir

private

Defines UI directory for "/geant4e/" commands.

Definition at line 63 of file ExtMessenger.h.

m_dirLimits

G4UIdirectory* m_dirLimits

private

Defines UI directory for "/geant4e/limits/" commands.

Definition at line 66 of file ExtMessenger.h.

m_energyLossAction

ExtEnergyLoss* m_energyLossAction

private

Process that limits the geant4e step length due to energy loss.

Definition at line 60 of file ExtMessenger.h.

m_energyLossCmd

G4UIcmdWithADouble* m_energyLossCmd

private

defines UI command "/geant4e/limits/energyLoss" to limit step length

Definition at line 75 of file ExtMessenger.h.

m_magFieldAction

ExtMagFieldLimitProcess* m_magFieldAction

private

Process that limits the geant4e step length in magnetic field.

Definition at line 57 of file ExtMessenger.h.

m_magFieldLimitCmd

G4UIcmdWithADouble* m_magFieldLimitCmd

private

Defines UI command "/geant4e/limits/magField" to limit step length.

Definition at line 72 of file ExtMessenger.h.

m_stepLengthAction

ExtStepLengthLimitProcess* m_stepLengthAction

private

Process that limits the geant4e step length.

Definition at line 54 of file ExtMessenger.h.

m_stepLengthLimitCmd

G4UIcmdWithADoubleAndUnit* m_stepLengthLimitCmd

private

Defines UI command "/geant4e/limits/stepLength" to limit step length.

Definition at line 69 of file ExtMessenger.h.

---

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

• simulation/kernel/include/ExtMessenger.h
• simulation/kernel/src/ExtMessenger.cc