RadioBio::DoseMessenger Class Reference

#include <Doxymodules_medical.h>

Inheritance diagram for RadioBio::DoseMessenger:

Public Member Functions
	DoseMessenger (Dose *)
	~DoseMessenger () override
void	SetNewValue (G4UIcommand *, G4String) override

Private Attributes
Dose *	fDose = nullptr
G4UIdirectory *	fDoseDir = nullptr
G4UIcmdWithABool *	fCalculationCmd = nullptr
G4UIcmdWithAnInteger *	fVerbosityCmd = nullptr
G4UIcmdWithoutParameter *	fResetCmd = nullptr
G4UIcmdWithAString *	fDosePathCmd = nullptr
G4UIcmdWithoutParameter *	fPrintCmd = nullptr

Detailed Description

Definition at line 131 of file Doxymodules_medical.h.

Constructor & Destructor Documentation

DoseMessenger()

RadioBio::DoseMessenger::DoseMessenger

(

Dose *

dose

)

Definition at line 45 of file DoseMessenger.cc.

                                       : G4UImessenger(), fDose(dose)
{
  // Diretory for dose commands
  fDoseDir = new G4UIdirectory("/dose/");
  fDoseDir->SetGuidance("commands to setup dose calculation");
 
  // Activate dose calculation
  fCalculationCmd = new G4UIcmdWithABool("/dose/calculate", this);
  fCalculationCmd->SetGuidance("Whether to enable dose calculation");
  fCalculationCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fCalculationCmd->SetToBeBroadcasted(false);
 
  // Set dose verbosity
  fVerbosityCmd = new G4UIcmdWithAnInteger("/dose/verbose", this);
  fVerbosityCmd->SetGuidance("Set verbosity level of dose");
  fVerbosityCmd->SetGuidance("0 = quiet");
  fVerbosityCmd->SetGuidance("1 = important messages (~10 per run)");
  fVerbosityCmd->SetGuidance("2 = debug");
  fVerbosityCmd->SetToBeBroadcasted(false);
 
  // Reset dose data
  fResetCmd = new G4UIcmdWithoutParameter("/dose/reset", this);
  fResetCmd->SetGuidance("Reset accumulated data");
  fResetCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fResetCmd->SetToBeBroadcasted(false);
 
  // Set dose filename
  fDosePathCmd = new G4UIcmdWithAString("/dose/fileName", this);
  fDosePathCmd->SetGuidance("Set the filename for the dose file");
  fDosePathCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fDosePathCmd->SetToBeBroadcasted(false);
 
  // Print Parameters
  fPrintCmd = new G4UIcmdWithoutParameter("/dose/print", this);
  fPrintCmd->SetGuidance("Print dose parameters");
  fPrintCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fPrintCmd->SetToBeBroadcasted(false);
}

~DoseMessenger()

RadioBio::DoseMessenger::~DoseMessenger ( )

override

Definition at line 86 of file DoseMessenger.cc.

{
  delete fDoseDir;
  delete fCalculationCmd;
  delete fVerbosityCmd;
  delete fResetCmd;
  delete fDosePathCmd;
  delete fPrintCmd;
}

Member Function Documentation

SetNewValue()

void RadioBio::DoseMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValue  )

override

Definition at line 98 of file DoseMessenger.cc.

{
  if (command == fCalculationCmd) {
    fDose->SetCalculationEnabled(fCalculationCmd->GetNewBoolValue(newValue));
  }
 
  if (command == fVerbosityCmd) {
    fDose->SetVerboseLevel(fVerbosityCmd->GetNewIntValue(newValue));
  }
 
  if (command == fResetCmd) {
    fDose->Reset();
  }
 
  if (command == fDosePathCmd) {
    fDose->SetPath(newValue);
  }
 
  if (command == fPrintCmd) {
    fDose->PrintParameters();
  }
}

Member Data Documentation

fDose

Dose* RadioBio::DoseMessenger::fDose = nullptr

private

Definition at line 57 of file DoseMessenger.hh.

fDoseDir

G4UIdirectory* RadioBio::DoseMessenger::fDoseDir = nullptr

private

Definition at line 59 of file DoseMessenger.hh.

fCalculationCmd

G4UIcmdWithABool* RadioBio::DoseMessenger::fCalculationCmd = nullptr

private

Definition at line 60 of file DoseMessenger.hh.

fVerbosityCmd

G4UIcmdWithAnInteger* RadioBio::DoseMessenger::fVerbosityCmd = nullptr

private

Definition at line 61 of file DoseMessenger.hh.

fResetCmd

G4UIcmdWithoutParameter* RadioBio::DoseMessenger::fResetCmd = nullptr

private

Definition at line 62 of file DoseMessenger.hh.

fDosePathCmd

G4UIcmdWithAString* RadioBio::DoseMessenger::fDosePathCmd = nullptr

private

Definition at line 63 of file DoseMessenger.hh.

fPrintCmd

G4UIcmdWithoutParameter* RadioBio::DoseMessenger::fPrintCmd = nullptr

private

Definition at line 64 of file DoseMessenger.hh.

---

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

• .doxygen/Doxymodules_medical.h
• extended/medical/radiobiology/include/DoseMessenger.hh
• extended/medical/radiobiology/src/DoseMessenger.cc