F03FieldMessenger Class Reference

#include <Doxymodules_field.h>

Inheritance diagram for F03FieldMessenger:

Public Member Functions
	F03FieldMessenger (F03FieldSetup *)
	~F03FieldMessenger () override
void	SetNewValue (G4UIcommand *, G4String) override

Private Attributes
F03FieldSetup *	fEMfieldSetup = nullptr
G4UIdirectory *	fFieldDir = nullptr
G4UIcmdWithAnInteger *	fStepperCmd = nullptr
G4UIcmdWithADoubleAndUnit *	fMagFieldZCmd = nullptr
G4UIcmdWith3VectorAndUnit *	fMagFieldCmd = nullptr
G4UIcmdWith3VectorAndUnit *	fLocalMagFieldCmd = nullptr
G4UIcmdWithADoubleAndUnit *	fMinStepCmd = nullptr
G4UIcmdWithoutParameter *	fUpdateCmd = nullptr

Detailed Description

Definition at line 83 of file Doxymodules_field.h.

Constructor & Destructor Documentation

F03FieldMessenger()

F03FieldMessenger::F03FieldMessenger

(

F03FieldSetup *

fieldSetup

)

Definition at line 47 of file F03FieldMessenger.cc.

 : fEMfieldSetup(fieldSetup)
{
  fFieldDir = new G4UIdirectory("/field/");
  fFieldDir->SetGuidance("F03 field tracking control.");
 
  fStepperCmd = new G4UIcmdWithAnInteger("/field/setStepperType",this);
  fStepperCmd->SetGuidance("Select stepper type for magnetic field");
  fStepperCmd->SetParameterName("choice",true);
  fStepperCmd->SetDefaultValue(4);
  fStepperCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
 
  fUpdateCmd = new G4UIcmdWithoutParameter("/field/update",this);
  fUpdateCmd->SetGuidance("Update calorimeter geometry.");
  fUpdateCmd->SetGuidance("This command MUST be applied before \"beamOn\" ");
  fUpdateCmd->SetGuidance("if you changed geometrical value(s).");
  fUpdateCmd->AvailableForStates(G4State_Idle);
 
  fMagFieldZCmd = new G4UIcmdWithADoubleAndUnit("/field/setFieldZ",this);
  fMagFieldZCmd->SetGuidance("Define global magnetic field.");
  fMagFieldZCmd->SetGuidance("Global magnetic field will be in Z direction.");
  fMagFieldZCmd->SetParameterName("Bz",false,false);
  fMagFieldZCmd->SetDefaultUnit("tesla");
  fMagFieldZCmd->AvailableForStates(G4State_Idle);
 
  fMagFieldCmd = new G4UIcmdWith3VectorAndUnit("/field/setField",this);
  fMagFieldCmd->SetGuidance("Define global magnetic field.");
  fMagFieldCmd->SetParameterName("Bx","By","Bz",false,false);
  fMagFieldCmd->SetDefaultUnit("tesla");
  fMagFieldCmd->AvailableForStates(G4State_Idle);
 
  fLocalMagFieldCmd = new G4UIcmdWith3VectorAndUnit("/field/setLocalField",this);
  fLocalMagFieldCmd->SetGuidance("Define local magnetic field.");
  fLocalMagFieldCmd->SetParameterName("Blx","Bly","Blz",false,false);
  fLocalMagFieldCmd->SetDefaultUnit("tesla");
  fLocalMagFieldCmd->AvailableForStates(G4State_Idle);
 
  fMinStepCmd = new G4UIcmdWithADoubleAndUnit("/field/setMinStep",this);
  fMinStepCmd->SetGuidance("Define minimal step");
  fMinStepCmd->SetGuidance("Magnetic field will be in Z direction.");
  fMinStepCmd->SetParameterName("min step",false,false);
  fMinStepCmd->SetDefaultUnit("mm");
  fMinStepCmd->AvailableForStates(G4State_Idle);
}

~F03FieldMessenger()

F03FieldMessenger::~F03FieldMessenger ( )

override

Definition at line 94 of file F03FieldMessenger.cc.

{
  delete fStepperCmd;
  delete fMagFieldZCmd;
  delete fMagFieldCmd;
  delete fLocalMagFieldCmd;
  delete fMinStepCmd;
  delete fFieldDir;
  delete fUpdateCmd;
}

Member Function Documentation

SetNewValue()

void F03FieldMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValue  )

override

Definition at line 107 of file F03FieldMessenger.cc.

{
  if( command == fStepperCmd )
    fEMfieldSetup->SetStepperType(fStepperCmd->GetNewIntValue(newValue));
  if( command == fUpdateCmd )
    fEMfieldSetup->UpdateField();
  if( command == fMagFieldZCmd )
  {
    fEMfieldSetup->SetFieldZValue(fMagFieldZCmd->GetNewDoubleValue(newValue));
    // Check the value
    G4cout << "Set global field value to " <<
      fEMfieldSetup->GetGlobalFieldValue() / gauss << " Gauss " << G4endl;
  }
  if( command == fMagFieldCmd )
  {
    fEMfieldSetup->SetFieldValue(fMagFieldCmd->GetNew3VectorValue(newValue));
    // Check the value
    G4cout << "Set global field value to " <<
      fEMfieldSetup->GetGlobalFieldValue() / gauss << " Gauss " << G4endl;
  }
  if( command == fLocalMagFieldCmd )
  {
    fEMfieldSetup->SetLocalFieldValue(fLocalMagFieldCmd->GetNew3VectorValue(newValue));
    fEMfieldSetup->UpdateField();
    // Check the value
    G4cout << "Set local field value to " <<
      fEMfieldSetup->GetLocalFieldValue() / gauss << " Gauss " << G4endl;
  }
  if( command == fMinStepCmd )
    fEMfieldSetup->SetMinStep(fMinStepCmd->GetNewDoubleValue(newValue));
}

Member Data Documentation

fEMfieldSetup

F03FieldSetup* F03FieldMessenger::fEMfieldSetup = nullptr

private

Definition at line 59 of file F03FieldMessenger.hh.

fFieldDir

G4UIdirectory* F03FieldMessenger::fFieldDir = nullptr

private

Definition at line 61 of file F03FieldMessenger.hh.

fStepperCmd

G4UIcmdWithAnInteger* F03FieldMessenger::fStepperCmd = nullptr

private

Definition at line 63 of file F03FieldMessenger.hh.

fMagFieldZCmd

G4UIcmdWithADoubleAndUnit* F03FieldMessenger::fMagFieldZCmd = nullptr

private

Definition at line 64 of file F03FieldMessenger.hh.

fMagFieldCmd

G4UIcmdWith3VectorAndUnit* F03FieldMessenger::fMagFieldCmd = nullptr

private

Definition at line 65 of file F03FieldMessenger.hh.

fLocalMagFieldCmd

G4UIcmdWith3VectorAndUnit* F03FieldMessenger::fLocalMagFieldCmd = nullptr

private

Definition at line 66 of file F03FieldMessenger.hh.

fMinStepCmd

G4UIcmdWithADoubleAndUnit* F03FieldMessenger::fMinStepCmd = nullptr

private

Definition at line 67 of file F03FieldMessenger.hh.

fUpdateCmd

G4UIcmdWithoutParameter* F03FieldMessenger::fUpdateCmd = nullptr

private

Definition at line 68 of file F03FieldMessenger.hh.

---

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

• .doxygen/Doxymodules_field.h
• extended/field/field03/include/F03FieldMessenger.hh
• extended/field/field03/src/F03FieldMessenger.cc