RadioBio::RBEMessenger Class Reference

#include <Doxymodules_medical.h>

Inheritance diagram for RadioBio::RBEMessenger:

Public Member Functions
	RBEMessenger (RBE *)
	~RBEMessenger () override
void	SetNewValue (G4UIcommand *, G4String) override

Private Attributes
RBE *	fRBE = nullptr
G4UIdirectory *	fRBEDir = nullptr
G4UIcmdWithABool *	fCalculationCmd = nullptr
G4UIcmdWithAnInteger *	fVerbosityCmd = nullptr
G4UIcmdWithAString *	fLemTableCmd = nullptr
G4UIcmdWithAString *	fCellLineCmd = nullptr
G4UIcmdWithoutParameter *	fResetCmd = nullptr
G4UIcmdWithoutParameter *	fPrintCmd = nullptr

Detailed Description

Definition at line 143 of file Doxymodules_medical.h.

Constructor & Destructor Documentation

RBEMessenger()

RadioBio::RBEMessenger::RBEMessenger

(

RBE *

rbe

)

Definition at line 45 of file RBEMessenger.cc.

                                   : G4UImessenger(), fRBE(rbe)
{
  // Directory for RBE commands
  fRBEDir = new G4UIdirectory("/rbe/");
  fRBEDir->SetGuidance("commands to setup RBE calculation");
 
  // Activate RBE calculation
  fCalculationCmd = new G4UIcmdWithABool("/rbe/calculate", this);
  fCalculationCmd->SetGuidance("Whether to enable RBE calculation");
  fCalculationCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fCalculationCmd->SetToBeBroadcasted(false);
 
  // Set RBE verbosity
  fVerbosityCmd = new G4UIcmdWithAnInteger("/rbe/verbose", this);
  fVerbosityCmd->SetGuidance("Set verbosity level of RBE");
  fVerbosityCmd->SetGuidance("0 = quiet");
  fVerbosityCmd->SetGuidance("1 = important messages (~10 per run)");
  fVerbosityCmd->SetGuidance("2 = debug");
  fVerbosityCmd->SetToBeBroadcasted(false);
 
  // Load a LEM table
  fLemTableCmd = new G4UIcmdWithAString("/rbe/loadLemTable", this);
  fLemTableCmd->SetGuidance("Load a LEM table used in calculating alpha&beta");
  fLemTableCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fLemTableCmd->SetToBeBroadcasted(false);
 
  // Load a cell line
  fCellLineCmd = new G4UIcmdWithAString("/rbe/cellLine", this);
  fCellLineCmd->SetGuidance("Set the cell line for alpha&beta calculation");
  fCellLineCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fCellLineCmd->SetToBeBroadcasted(false);
 
  // Reset RBE data
  fResetCmd = new G4UIcmdWithoutParameter("/rbe/reset", this);
  fResetCmd->SetGuidance("Reset accumulated data");
  fResetCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fResetCmd->SetToBeBroadcasted(false);
 
  // Print Parameters
  fPrintCmd = new G4UIcmdWithoutParameter("/rbe/print", this);
  fPrintCmd->SetGuidance("Print RBE parameters");
  fPrintCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  fPrintCmd->SetToBeBroadcasted(false);
}

~RBEMessenger()

RadioBio::RBEMessenger::~RBEMessenger ( )

override

Definition at line 92 of file RBEMessenger.cc.

{
  delete fRBEDir;
  delete fCalculationCmd;
  delete fVerbosityCmd;
  delete fLemTableCmd;
  delete fCellLineCmd;
  delete fResetCmd;
  delete fPrintCmd;
}

Member Function Documentation

SetNewValue()

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

override

Definition at line 105 of file RBEMessenger.cc.

{
  if (command == fCalculationCmd) {
    fRBE->SetCalculationEnabled(fCalculationCmd->GetNewBoolValue(newValue));
  }
 
  if (command == fVerbosityCmd) {
    fRBE->SetVerboseLevel(fVerbosityCmd->GetNewIntValue(newValue));
  }
 
  if (command == fLemTableCmd) {
    fRBE->LoadLEMTable(newValue);
  }
 
  if (command == fCellLineCmd) {
    fRBE->SetCellLine(newValue);
  }
 
  if (command == fResetCmd) {
    fRBE->Reset();
  }
 
  if (command == fPrintCmd) {
    fRBE->PrintParameters();
  }
}

Member Data Documentation

fRBE

RBE* RadioBio::RBEMessenger::fRBE = nullptr

private

Definition at line 57 of file RBEMessenger.hh.

fRBEDir

G4UIdirectory* RadioBio::RBEMessenger::fRBEDir = nullptr

private

Definition at line 59 of file RBEMessenger.hh.

fCalculationCmd

G4UIcmdWithABool* RadioBio::RBEMessenger::fCalculationCmd = nullptr

private

Definition at line 60 of file RBEMessenger.hh.

fVerbosityCmd

G4UIcmdWithAnInteger* RadioBio::RBEMessenger::fVerbosityCmd = nullptr

private

Definition at line 61 of file RBEMessenger.hh.

fLemTableCmd

G4UIcmdWithAString* RadioBio::RBEMessenger::fLemTableCmd = nullptr

private

Definition at line 62 of file RBEMessenger.hh.

fCellLineCmd

G4UIcmdWithAString* RadioBio::RBEMessenger::fCellLineCmd = nullptr

private

Definition at line 63 of file RBEMessenger.hh.

fResetCmd

G4UIcmdWithoutParameter* RadioBio::RBEMessenger::fResetCmd = nullptr

private

Definition at line 64 of file RBEMessenger.hh.

fPrintCmd

G4UIcmdWithoutParameter* RadioBio::RBEMessenger::fPrintCmd = nullptr

private

Definition at line 65 of file RBEMessenger.hh.

---

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

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