Par03DetectorMessenger Class Reference

Detector messenger. More...

#include <Doxymodules_parameterisations.h>

Inheritance diagram for Par03DetectorMessenger:

Public Member Functions
	Par03DetectorMessenger (Par03DetectorConstruction *)
	~Par03DetectorMessenger ()
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
Par03DetectorConstruction *	fDetector = nullptr
	Detector construction to setup.
G4UIdirectory *	fExampleDir = nullptr
	Command to set the directory common to all messengers in this example /Par03.
G4UIdirectory *	fDetectorDir = nullptr
	Command to set the directory for detector settings /Par03/detector.
G4UIcmdWithoutParameter *	fPrintCmd
	Command printing current settings.
G4UIcmdWithADoubleAndUnit *	fDetectorRadiusCmd = nullptr
	Command to set the detector radius.
G4UIcmdWithADoubleAndUnit *	fDetectorLengthCmd = nullptr
	Command to set the detector length.
G4UIcmdWithAString *	fDetectorMaterialCmd = nullptr
	Command to set the detector material.
G4UIcmdWithAnInteger *	fNbLayersCmd = nullptr
	Command to set the number of layers.
G4UIcmdWithAnInteger *	fNbRhoCellsCmd = nullptr
	Command to set the number of radial cells.
G4UIcmdWithAnInteger *	fNbPhiCellsCmd = nullptr
	Command to set the number of cells in azimuthal angle.

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 61 of file Doxymodules_parameterisations.h.

Constructor & Destructor Documentation

Par03DetectorMessenger()

Par03DetectorMessenger::Par03DetectorMessenger

(

Par03DetectorConstruction *

aDetector

)

Definition at line 37 of file Par03DetectorMessenger.cc.

  : G4UImessenger()
  , fDetector(aDetector)
{
  fExampleDir = new G4UIdirectory("/Par03/");
  fExampleDir->SetGuidance("UI commands specific to this example");
 
  fDetectorDir = new G4UIdirectory("/Par03/detector/");
  fDetectorDir->SetGuidance("Detector construction UI commands");
 
  fPrintCmd = new G4UIcmdWithoutParameter("/Par03/detector/print", this);
  fPrintCmd->SetGuidance("Print current settings.");
 
  fDetectorRadiusCmd =
    new G4UIcmdWithADoubleAndUnit("/Par03/detector/setDetectorRadius", this);
  fDetectorRadiusCmd->SetGuidance(
    "Set tranverse size of the detector (cylinder radius)");
  fDetectorRadiusCmd->SetParameterName("Size", false);
  fDetectorRadiusCmd->SetRange("Size>0.");
  fDetectorRadiusCmd->SetUnitCategory("Length");
  fDetectorRadiusCmd->AvailableForStates(G4State_PreInit);
  fDetectorRadiusCmd->SetToBeBroadcasted(false);
 
  fDetectorLengthCmd =
    new G4UIcmdWithADoubleAndUnit("/Par03/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);
 
  fDetectorMaterialCmd =
    new G4UIcmdWithAString("/Par03/detector/setDetectorMaterial", this);
  fDetectorMaterialCmd->SetGuidance("Material of the detector.");
  fDetectorMaterialCmd->SetParameterName("Name", false);
  fDetectorMaterialCmd->AvailableForStates(G4State_PreInit);
  fDetectorMaterialCmd->SetToBeBroadcasted(false);
 
  fNbLayersCmd =
    new G4UIcmdWithAnInteger("/Par03/detector/setNbOfLayers", this);
  fNbLayersCmd->SetGuidance("Set number of layers.");
  fNbLayersCmd->SetParameterName("NbLayers", false);
  fNbLayersCmd->SetRange("NbLayers>0");
  fNbLayersCmd->AvailableForStates(G4State_PreInit);
  fNbLayersCmd->SetToBeBroadcasted(false);
 
  fNbRhoCellsCmd =
    new G4UIcmdWithAnInteger("/Par03/detector/setNbOfRhoCells", this);
  fNbRhoCellsCmd->SetGuidance("Set number of cells along radius.");
  fNbRhoCellsCmd->SetParameterName("NbRhoCells", false);
  fNbRhoCellsCmd->SetRange("NbRhoCells>0");
  fNbRhoCellsCmd->AvailableForStates(G4State_PreInit);
  fNbRhoCellsCmd->SetToBeBroadcasted(false);
 
  fNbPhiCellsCmd =
    new G4UIcmdWithAnInteger("/Par03/detector/setNbOfPhiCells", this);
  fNbPhiCellsCmd->SetGuidance("Set number of cells in azimuthal angle.");
  fNbPhiCellsCmd->SetParameterName("NbPhiCells", false);
  fNbPhiCellsCmd->SetRange("NbPhiCells>0");
  fNbPhiCellsCmd->AvailableForStates(G4State_PreInit);
  fNbPhiCellsCmd->SetToBeBroadcasted(false);
}

~Par03DetectorMessenger()

Par03DetectorMessenger::~Par03DetectorMessenger

(

)

Definition at line 105 of file Par03DetectorMessenger.cc.

{
  delete fPrintCmd;
  delete fDetectorRadiusCmd;
  delete fDetectorLengthCmd;
  delete fDetectorMaterialCmd;
  delete fNbLayersCmd;
  delete fNbRhoCellsCmd;
  delete fNbPhiCellsCmd;
  delete fDetectorDir;
  delete fExampleDir;
}

Member Function Documentation

SetNewValue()

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

finalvirtual

Invokes appropriate methods based on the typed command.

Definition at line 120 of file Par03DetectorMessenger.cc.

{
  if(aCommand == fPrintCmd)
  {
    fDetector->Print();
  }
  else if(aCommand == fDetectorRadiusCmd)
  {
    fDetector->SetRadius(fDetectorRadiusCmd->GetNewDoubleValue(aNewValue));
  }
  else if(aCommand == fDetectorLengthCmd)
  {
    fDetector->SetLength(fDetectorRadiusCmd->GetNewDoubleValue(aNewValue));
  }
  else if(aCommand == fDetectorMaterialCmd)
  {
    fDetector->SetMaterial(aNewValue);
  }
  else if(aCommand == fNbLayersCmd)
  {
    fDetector->SetNbOfLayers(fNbLayersCmd->GetNewIntValue(aNewValue));
  }
  else if(aCommand == fNbRhoCellsCmd)
  {
    fDetector->SetNbOfRhoCells(fNbRhoCellsCmd->GetNewIntValue(aNewValue));
  }
  else if(aCommand == fNbPhiCellsCmd)
  {
    fDetector->SetNbOfPhiCells(fNbPhiCellsCmd->GetNewIntValue(aNewValue));
  }
}

GetCurrentValue()

G4String Par03DetectorMessenger::GetCurrentValue ( G4UIcommand *  aCommand )

finalvirtual

Retrieves the current settings.

Definition at line 155 of file Par03DetectorMessenger.cc.

{
  G4String cv;
 
  if(aCommand == fDetectorRadiusCmd)
  {
    cv = fDetectorRadiusCmd->ConvertToString(fDetector->GetRadius(), "mm");
  }
  else if(aCommand == fDetectorLengthCmd)
  {
    cv = fDetectorLengthCmd->ConvertToString(fDetector->GetLength(), "mm");
  }
  else if(aCommand == fDetectorMaterialCmd)
  {
    cv = fDetector->GetMaterial();
  }
  else if(aCommand == fNbLayersCmd)
  {
    cv = fNbLayersCmd->ConvertToString(fDetector->GetNbOfLayers());
  }
  else if(aCommand == fNbPhiCellsCmd)
  {
    cv = fNbPhiCellsCmd->ConvertToString(fDetector->GetNbOfPhiCells());
  }
  else if(aCommand == fNbRhoCellsCmd)
  {
    cv = fNbRhoCellsCmd->ConvertToString(fDetector->GetNbOfRhoCells());
  }
  return cv;
}

Member Data Documentation

fDetector

Par03DetectorConstruction* Par03DetectorMessenger::fDetector = nullptr

private

Detector construction to setup.

Definition at line 61 of file Par03DetectorMessenger.hh.

fExampleDir

G4UIdirectory* Par03DetectorMessenger::fExampleDir = nullptr

private

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

Definition at line 64 of file Par03DetectorMessenger.hh.

fDetectorDir

G4UIdirectory* Par03DetectorMessenger::fDetectorDir = nullptr

private

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

Definition at line 66 of file Par03DetectorMessenger.hh.

fPrintCmd

G4UIcmdWithoutParameter* Par03DetectorMessenger::fPrintCmd

private

Command printing current settings.

Definition at line 68 of file Par03DetectorMessenger.hh.

fDetectorRadiusCmd

G4UIcmdWithADoubleAndUnit* Par03DetectorMessenger::fDetectorRadiusCmd = nullptr

private

Command to set the detector radius.

Definition at line 70 of file Par03DetectorMessenger.hh.

fDetectorLengthCmd

G4UIcmdWithADoubleAndUnit* Par03DetectorMessenger::fDetectorLengthCmd = nullptr

private

Command to set the detector length.

Definition at line 72 of file Par03DetectorMessenger.hh.

fDetectorMaterialCmd

G4UIcmdWithAString* Par03DetectorMessenger::fDetectorMaterialCmd = nullptr

private

Command to set the detector material.

Definition at line 74 of file Par03DetectorMessenger.hh.

fNbLayersCmd

G4UIcmdWithAnInteger* Par03DetectorMessenger::fNbLayersCmd = nullptr

private

Command to set the number of layers.

Definition at line 76 of file Par03DetectorMessenger.hh.

fNbRhoCellsCmd

G4UIcmdWithAnInteger* Par03DetectorMessenger::fNbRhoCellsCmd = nullptr

private

Command to set the number of radial cells.

Definition at line 78 of file Par03DetectorMessenger.hh.

fNbPhiCellsCmd

G4UIcmdWithAnInteger* Par03DetectorMessenger::fNbPhiCellsCmd = nullptr

private

Command to set the number of cells in azimuthal angle.

Definition at line 80 of file Par03DetectorMessenger.hh.

---

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

• .doxygen/Doxymodules_parameterisations.h
• extended/parameterisations/Par03/include/Par03DetectorMessenger.hh
• extended/parameterisations/Par03/src/Par03DetectorMessenger.cc