Par04DetectorMessenger Class Reference

Detector messenger. More...

#include <Doxymodules_parameterisations.h>

Inheritance diagram for Par04DetectorMessenger:

Public Member Functions
	Par04DetectorMessenger (Par04DetectorConstruction *)
	~Par04DetectorMessenger ()
virtual void	SetNewValue (G4UIcommand *, G4String) final
	Invokes appropriate methods based on the typed command.
virtual G4String	GetCurrentValue (G4UIcommand *) final
	Retrieves the current settings.

Private Attributes
Par04DetectorConstruction *	fDetector = nullptr
	Detector construction to setup.
G4UIdirectory *	fExampleDir = nullptr
	Command to set the directory common to all messengers in this example /Par04.
G4UIdirectory *	fDetectorDir = nullptr
	Command to set the directory for detector settings /Par04/detector.
G4UIcmdWithoutParameter *	fPrintCmd
	Command printing current settings.
G4UIcmdWithADoubleAndUnit *	fDetectorInnerRadiusCmd = nullptr
	Command to set the detector inner radius.
G4UIcmdWithADoubleAndUnit *	fDetectorLengthCmd = nullptr
	Command to set the detector length.
G4UIcmdWithAnInteger *	fNbLayersCmd = nullptr
	Command to set the number of layers.
G4UIcommand *	fAbsorCmd = nullptr
	Commanbd to set the absorbers within layers (material, thickness, sensitivity)
G4UIdirectory *	fMeshDir = nullptr
	Command to set the directory for sensitive detector settings /Par04/mesh.
G4UIcmdWithAnInteger *	fMeshNbRhoCellsCmd = nullptr
	Command to set the number of cells in the cylindrical readout mesh (along rho axis)
G4UIcmdWithAnInteger *	fMeshNbPhiCellsCmd = nullptr
	Command to set the number of cells in the cylindrical readout mesh (along phi axis)
G4UIcmdWithAnInteger *	fMeshNbZCellsCmd = nullptr
	Command to set the number of cells in the cylindrical readout mesh (along z axis)
G4UIcmdWithADoubleAndUnit *	fMeshSizeRhoCellsCmd = nullptr
	Command to the size of cells in the cylindrical readout mesh (along rho axis)
G4UIcmdWithADoubleAndUnit *	fMeshSizeZCellsCmd = nullptr
	Command to the size of cells in the cylindrical readout mesh (along z axis)

Detailed Description

Detector messenger.

Provides UI commands to setup detector and readout geometry (prior to initialization). Radius, length, and material of the detector, as well as segmentation of the readout geometry can be changed.

Definition at line 80 of file Doxymodules_parameterisations.h.

Constructor & Destructor Documentation

Par04DetectorMessenger()

Par04DetectorMessenger::Par04DetectorMessenger

(

Par04DetectorConstruction *

aDetector

)

Definition at line 44 of file Par04DetectorMessenger.cc.

  : G4UImessenger()
  , fDetector(aDetector)
{
  fExampleDir = new G4UIdirectory("/Par04/");
  fExampleDir->SetGuidance("UI commands specific to this example");
 
  fDetectorDir = new G4UIdirectory("/Par04/detector/");
  fDetectorDir->SetGuidance("Detector construction UI commands");
 
  fPrintCmd = new G4UIcmdWithoutParameter("/Par04/detector/print", this);
  fPrintCmd->SetGuidance("Print current settings.");
 
  fDetectorInnerRadiusCmd =
    new G4UIcmdWithADoubleAndUnit("/Par04/detector/setDetectorInnerRadius", this);
  fDetectorInnerRadiusCmd->SetGuidance("Set cylindrical detector inner radius");
  fDetectorInnerRadiusCmd->SetParameterName("Size", false);
  fDetectorInnerRadiusCmd->SetRange("Size>0.");
  fDetectorInnerRadiusCmd->SetUnitCategory("Length");
  fDetectorInnerRadiusCmd->AvailableForStates(G4State_PreInit);
  fDetectorInnerRadiusCmd->SetToBeBroadcasted(false);
 
  fDetectorLengthCmd = new G4UIcmdWithADoubleAndUnit("/Par04/detector/setDetectorLength", this);
  fDetectorLengthCmd->SetGuidance("Set length of the detector (cylinder length)");
  fDetectorLengthCmd->SetParameterName("Size", false);
  fDetectorLengthCmd->SetRange("Size>0.");
  fDetectorLengthCmd->SetUnitCategory("Length");
  fDetectorLengthCmd->AvailableForStates(G4State_PreInit);
  fDetectorLengthCmd->SetToBeBroadcasted(false);
 
  fNbLayersCmd = new G4UIcmdWithAnInteger("/Par04/detector/setNbOfLayers", this);
  fNbLayersCmd->SetGuidance("Set number of layers.");
  fNbLayersCmd->SetParameterName("NbLayers", false);
  fNbLayersCmd->SetRange("NbLayers>0");
  fNbLayersCmd->AvailableForStates(G4State_PreInit);
  fNbLayersCmd->SetToBeBroadcasted(false);
 
  fAbsorCmd = new G4UIcommand("/Par04/detector/setAbsorber", this);
  fAbsorCmd->SetGuidance("Set the absorber id, the material, the thickness.");
  fAbsorCmd->SetGuidance("  absorber number : from 0 to 1");
  fAbsorCmd->SetGuidance("  material name");
  fAbsorCmd->SetGuidance("  thickness (with unit) : t>0");
  fAbsorCmd->SetGuidance("  if sensitive : true/false.");
  auto  absNbPrm = new G4UIparameter("AbsorNb", 'i', false);
  absNbPrm->SetGuidance("absor number : from 0 to 1");
  absNbPrm->SetParameterRange("AbsorNb>-1&AbsoNb<2");
  fAbsorCmd->SetParameter(absNbPrm);
  auto  matPrm = new G4UIparameter("material", 's', false);
  matPrm->SetGuidance("material name");
  fAbsorCmd->SetParameter(matPrm);
  auto  thickPrm = new G4UIparameter("thickness", 'd', false);
  thickPrm->SetGuidance("thickness of absorber");
  thickPrm->SetParameterRange("thickness>0.");
  fAbsorCmd->SetParameter(thickPrm);
  auto  unitPrm = new G4UIparameter("unit", 's', false);
  unitPrm->SetGuidance("unit of thickness");
  G4String unitList = G4UIcommand::UnitsList(G4UIcommand::CategoryOf("mm"));
  unitPrm->SetParameterCandidates(unitList);
  fAbsorCmd->SetParameter(unitPrm);
  auto  sensitivePrm = new G4UIparameter("sensitive", 'b', false);
  sensitivePrm->SetGuidance("if absorber is sensitive (registers energy deposits)");
  fAbsorCmd->SetParameter(sensitivePrm);
 
  fAbsorCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fAbsorCmd->SetToBeBroadcasted(false);
 
  fMeshDir = new G4UIdirectory("/Par04/mesh/");
  fMeshDir->SetGuidance("Mesh UI commands");
 
  fMeshNbRhoCellsCmd = new G4UIcmdWithAnInteger("/Par04/mesh/setNbOfRhoCells", this);
  fMeshNbRhoCellsCmd->SetGuidance("Set number of rho cells in the cylindrical mesh readout.");
  fMeshNbRhoCellsCmd->SetParameterName("NbRhoCells", false);
  fMeshNbRhoCellsCmd->SetRange("NbRhoCells>0");
  fMeshNbRhoCellsCmd->AvailableForStates(G4State_PreInit);
  fMeshNbRhoCellsCmd->SetToBeBroadcasted(false);
 
  fMeshNbPhiCellsCmd = new G4UIcmdWithAnInteger("/Par04/mesh/setNbOfPhiCells", this);
  fMeshNbPhiCellsCmd->SetGuidance("Set number of phi cells in the cylindrical mesh readout.");
  fMeshNbPhiCellsCmd->SetParameterName("NbPhiCells", false);
  fMeshNbPhiCellsCmd->SetRange("NbPhiCells>0");
  fMeshNbPhiCellsCmd->AvailableForStates(G4State_PreInit);
  fMeshNbPhiCellsCmd->SetToBeBroadcasted(false);
 
  fMeshNbZCellsCmd = new G4UIcmdWithAnInteger("/Par04/mesh/setNbOfZCells", this);
  fMeshNbZCellsCmd->SetGuidance("Set number of z cells in the cylindrical mesh readout.");
  fMeshNbZCellsCmd->SetParameterName("NbZCells", false);
  fMeshNbZCellsCmd->SetRange("NbZCells>0");
  fMeshNbZCellsCmd->AvailableForStates(G4State_PreInit);
  fMeshNbZCellsCmd->SetToBeBroadcasted(false);
 
  fMeshSizeRhoCellsCmd = new G4UIcmdWithADoubleAndUnit("/Par04/mesh/setSizeOfRhoCells", this);
  fMeshSizeRhoCellsCmd->SetGuidance("Set size of rho cells in the cylindrical readout mesh");
  fMeshSizeRhoCellsCmd->SetParameterName("Size", false);
  fMeshSizeRhoCellsCmd->SetRange("Size>0.");
  fMeshSizeRhoCellsCmd->SetUnitCategory("Length");
  fMeshSizeRhoCellsCmd->AvailableForStates(G4State_PreInit);
  fMeshSizeRhoCellsCmd->SetToBeBroadcasted(false);
 
  fMeshSizeZCellsCmd = new G4UIcmdWithADoubleAndUnit("/Par04/mesh/setSizeOfZCells", this);
  fMeshSizeZCellsCmd->SetGuidance("Set size of z cells in the cylindrical readout mesh");
  fMeshSizeZCellsCmd->SetParameterName("Size", false);
  fMeshSizeZCellsCmd->SetRange("Size>0.");
  fMeshSizeZCellsCmd->SetUnitCategory("Length");
  fMeshSizeZCellsCmd->AvailableForStates(G4State_PreInit);
  fMeshSizeZCellsCmd->SetToBeBroadcasted(false);
}

~Par04DetectorMessenger()

Par04DetectorMessenger::~Par04DetectorMessenger

(

)

Definition at line 153 of file Par04DetectorMessenger.cc.

{
  delete fPrintCmd;
  delete fDetectorInnerRadiusCmd;
  delete fDetectorLengthCmd;
  delete fNbLayersCmd;
  delete fAbsorCmd;
  delete fDetectorDir;
  delete fMeshNbRhoCellsCmd;
  delete fMeshNbPhiCellsCmd;
  delete fMeshNbZCellsCmd;
  delete fMeshSizeRhoCellsCmd;
  delete fMeshSizeZCellsCmd;
  delete fMeshDir;
  delete fExampleDir;
}

Member Function Documentation

SetNewValue()

void Par04DetectorMessenger::SetNewValue ( G4UIcommand *  aCommand, G4String  aNewValue  )

finalvirtual

Invokes appropriate methods based on the typed command.

Definition at line 172 of file Par04DetectorMessenger.cc.

{
  if(aCommand == fPrintCmd)
  {
    fDetector->Print();
  }
  else if(aCommand == fDetectorInnerRadiusCmd)
  {
    fDetector->SetInnerRadius(fDetectorInnerRadiusCmd->GetNewDoubleValue(aNewValue));
  }
  else if(aCommand == fDetectorLengthCmd)
  {
    fDetector->SetLength(fDetectorInnerRadiusCmd->GetNewDoubleValue(aNewValue));
  }
  else if(aCommand == fNbLayersCmd)
  {
    fDetector->SetNbOfLayers(fNbLayersCmd->GetNewIntValue(aNewValue));
  }
  else if(aCommand == fAbsorCmd)
  {
    G4int num;
    G4double thick;
    G4String unt, mat;
    G4bool sensitive;
    std::istringstream is(aNewValue);
    is >> num >> mat >> thick >> unt >> std::boolalpha >> sensitive;
    G4String material = mat;
    thick *= G4UIcommand::ValueOf(unt);
    fDetector->SetAbsorberMaterial(num, material);
    fDetector->SetAbsorberThickness(num, thick);
    fDetector->SetAbsorberSensitivity(num, sensitive);
  }
  else if(aCommand == fMeshNbRhoCellsCmd)
  {
    fDetector->SetMeshNbOfCells(0, fMeshNbRhoCellsCmd->GetNewIntValue(aNewValue));
  }
  else if(aCommand == fMeshNbPhiCellsCmd)
  {
    fDetector->SetMeshNbOfCells(1, fMeshNbPhiCellsCmd->GetNewIntValue(aNewValue));
    fDetector->SetMeshSizeOfCells(1,
                                  2. * CLHEP::pi / fMeshNbPhiCellsCmd->GetNewIntValue(aNewValue));
  }
  else if(aCommand == fMeshNbZCellsCmd)
  {
    fDetector->SetMeshNbOfCells(2, fMeshNbZCellsCmd->GetNewIntValue(aNewValue));
  }
  else if(aCommand == fMeshSizeRhoCellsCmd)
  {
    fDetector->SetMeshSizeOfCells(0, fMeshSizeRhoCellsCmd->GetNewDoubleValue(aNewValue));
  }
  else if(aCommand == fMeshSizeZCellsCmd)
  {
    fDetector->SetMeshSizeOfCells(2, fMeshSizeZCellsCmd->GetNewDoubleValue(aNewValue));
  }
}

GetCurrentValue()

G4String Par04DetectorMessenger::GetCurrentValue ( G4UIcommand *  aCommand )

finalvirtual

Retrieves the current settings.

Definition at line 230 of file Par04DetectorMessenger.cc.

{
  G4String cv;
 
  if(aCommand == fDetectorInnerRadiusCmd)
  {
    cv = fDetectorInnerRadiusCmd->ConvertToString(fDetector->GetInnerRadius(), "mm");
  }
  else if(aCommand == fDetectorLengthCmd)
  {
    cv = fDetectorLengthCmd->ConvertToString(fDetector->GetLength(), "mm");
  }
  else if(aCommand == fNbLayersCmd)
  {
    cv = fNbLayersCmd->ConvertToString(fDetector->GetNbOfLayers());
  }
  else if(aCommand == fMeshNbRhoCellsCmd)
  {
    cv = fMeshNbRhoCellsCmd->ConvertToString(fDetector->GetMeshNbOfCells()[0]);
  }
  else if(aCommand == fMeshNbPhiCellsCmd)
  {
    cv = fMeshNbPhiCellsCmd->ConvertToString(fDetector->GetMeshNbOfCells()[1]);
  }
  else if(aCommand == fMeshNbZCellsCmd)
  {
    cv = fMeshNbZCellsCmd->ConvertToString(fDetector->GetMeshNbOfCells()[2]);
  }
  else if(aCommand == fMeshSizeRhoCellsCmd)
  {
    cv = fMeshSizeRhoCellsCmd->ConvertToString(fDetector->GetMeshSizeOfCells()[0]);
  }
  else if(aCommand == fMeshSizeZCellsCmd)
  {
    cv = fMeshSizeZCellsCmd->ConvertToString(fDetector->GetMeshSizeOfCells()[2]);
  }
  return cv;
}

Member Data Documentation

fDetector

Par04DetectorConstruction* Par04DetectorMessenger::fDetector = nullptr

private

Detector construction to setup.

Definition at line 61 of file Par04DetectorMessenger.hh.

fExampleDir

G4UIdirectory* Par04DetectorMessenger::fExampleDir = nullptr

private

Command to set the directory common to all messengers in this example /Par04.

Definition at line 64 of file Par04DetectorMessenger.hh.

fDetectorDir

G4UIdirectory* Par04DetectorMessenger::fDetectorDir = nullptr

private

Command to set the directory for detector settings /Par04/detector.

Definition at line 66 of file Par04DetectorMessenger.hh.

fPrintCmd

G4UIcmdWithoutParameter* Par04DetectorMessenger::fPrintCmd

private

Command printing current settings.

Definition at line 68 of file Par04DetectorMessenger.hh.

fDetectorInnerRadiusCmd

G4UIcmdWithADoubleAndUnit* Par04DetectorMessenger::fDetectorInnerRadiusCmd = nullptr

private

Command to set the detector inner radius.

Definition at line 70 of file Par04DetectorMessenger.hh.

fDetectorLengthCmd

G4UIcmdWithADoubleAndUnit* Par04DetectorMessenger::fDetectorLengthCmd = nullptr

private

Command to set the detector length.

Definition at line 72 of file Par04DetectorMessenger.hh.

fNbLayersCmd

G4UIcmdWithAnInteger* Par04DetectorMessenger::fNbLayersCmd = nullptr

private

Command to set the number of layers.

Definition at line 74 of file Par04DetectorMessenger.hh.

fAbsorCmd

G4UIcommand* Par04DetectorMessenger::fAbsorCmd = nullptr

private

Commanbd to set the absorbers within layers (material, thickness, sensitivity)

Definition at line 76 of file Par04DetectorMessenger.hh.

fMeshDir

G4UIdirectory* Par04DetectorMessenger::fMeshDir = nullptr

private

Command to set the directory for sensitive detector settings /Par04/mesh.

Definition at line 78 of file Par04DetectorMessenger.hh.

fMeshNbRhoCellsCmd

G4UIcmdWithAnInteger* Par04DetectorMessenger::fMeshNbRhoCellsCmd = nullptr

private

Command to set the number of cells in the cylindrical readout mesh (along rho axis)

Definition at line 80 of file Par04DetectorMessenger.hh.

fMeshNbPhiCellsCmd

G4UIcmdWithAnInteger* Par04DetectorMessenger::fMeshNbPhiCellsCmd = nullptr

private

Command to set the number of cells in the cylindrical readout mesh (along phi axis)

Definition at line 82 of file Par04DetectorMessenger.hh.

fMeshNbZCellsCmd

G4UIcmdWithAnInteger* Par04DetectorMessenger::fMeshNbZCellsCmd = nullptr

private

Command to set the number of cells in the cylindrical readout mesh (along z axis)

Definition at line 84 of file Par04DetectorMessenger.hh.

fMeshSizeRhoCellsCmd

G4UIcmdWithADoubleAndUnit* Par04DetectorMessenger::fMeshSizeRhoCellsCmd = nullptr

private

Command to the size of cells in the cylindrical readout mesh (along rho axis)

Definition at line 86 of file Par04DetectorMessenger.hh.

fMeshSizeZCellsCmd

G4UIcmdWithADoubleAndUnit* Par04DetectorMessenger::fMeshSizeZCellsCmd = nullptr

private

Command to the size of cells in the cylindrical readout mesh (along z axis)

Definition at line 88 of file Par04DetectorMessenger.hh.

---

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

• .doxygen/Doxymodules_parameterisations.h
• extended/parameterisations/Par04/include/Par04DetectorMessenger.hh
• extended/parameterisations/Par04/src/Par04DetectorMessenger.cc