radiobiology/src/RBEMessenger.cc

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 /// \file radiobiology/src/RBEMessenger.cc
0028 /// \brief Implementation of the RadioBio::RBEMessenger class
0029
0030 #include "RBEMessenger.hh"
0031
0032 #include "RBE.hh"
0033 #include <G4UIcmdWithABool.hh>
0034 #include <G4UIcmdWithADouble.hh>
0035 #include <G4UIcmdWithAString.hh>
0036 #include <G4UIcmdWithAnInteger.hh>
0037 #include <G4UIcmdWithoutParameter.hh>
0038 #include <G4UIdirectory.hh>
0039
0040 namespace RadioBio
0041 {
0042
0043 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0044
0045 RBEMessenger::RBEMessenger(RBE* rbe) : G4UImessenger(), fRBE(rbe)
0046 {
0047   // Directory for RBE commands
0048   fRBEDir = new G4UIdirectory("/rbe/");
0049   fRBEDir->SetGuidance("commands to setup RBE calculation");
0050
0051   // Activate RBE calculation
0052   fCalculationCmd = new G4UIcmdWithABool("/rbe/calculate", this);
0053   fCalculationCmd->SetGuidance("Whether to enable RBE calculation");
0054   fCalculationCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
0055   fCalculationCmd->SetToBeBroadcasted(false);
0056
0057   // Set RBE verbosity
0058   fVerbosityCmd = new G4UIcmdWithAnInteger("/rbe/verbose", this);
0059   fVerbosityCmd->SetGuidance("Set verbosity level of RBE");
0060   fVerbosityCmd->SetGuidance("0 = quiet");
0061   fVerbosityCmd->SetGuidance("1 = important messages (~10 per run)");
0062   fVerbosityCmd->SetGuidance("2 = debug");
0063   fVerbosityCmd->SetToBeBroadcasted(false);
0064
0065   // Load a LEM table
0066   fLemTableCmd = new G4UIcmdWithAString("/rbe/loadLemTable", this);
0067   fLemTableCmd->SetGuidance("Load a LEM table used in calculating alpha&beta");
0068   fLemTableCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
0069   fLemTableCmd->SetToBeBroadcasted(false);
0070
0071   // Load a cell line
0072   fCellLineCmd = new G4UIcmdWithAString("/rbe/cellLine", this);
0073   fCellLineCmd->SetGuidance("Set the cell line for alpha&beta calculation");
0074   fCellLineCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
0075   fCellLineCmd->SetToBeBroadcasted(false);
0076
0077   // Reset RBE data
0078   fResetCmd = new G4UIcmdWithoutParameter("/rbe/reset", this);
0079   fResetCmd->SetGuidance("Reset accumulated data");
0080   fResetCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
0081   fResetCmd->SetToBeBroadcasted(false);
0082
0083   // Print Parameters
0084   fPrintCmd = new G4UIcmdWithoutParameter("/rbe/print", this);
0085   fPrintCmd->SetGuidance("Print RBE parameters");
0086   fPrintCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
0087   fPrintCmd->SetToBeBroadcasted(false);
0088 }
0089
0090 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0091
0092 RBEMessenger::~RBEMessenger()
0093 {
0094   delete fRBEDir;
0095   delete fCalculationCmd;
0096   delete fVerbosityCmd;
0097   delete fLemTableCmd;
0098   delete fCellLineCmd;
0099   delete fResetCmd;
0100   delete fPrintCmd;
0101 }
0102
0103 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0104
0105 void RBEMessenger::SetNewValue(G4UIcommand* command, G4String newValue)
0106 {
0107   if (command == fCalculationCmd) {
0108     fRBE->SetCalculationEnabled(fCalculationCmd->GetNewBoolValue(newValue));
0109   }
0110
0111   if (command == fVerbosityCmd) {
0112     fRBE->SetVerboseLevel(fVerbosityCmd->GetNewIntValue(newValue));
0113   }
0114
0115   if (command == fLemTableCmd) {
0116     fRBE->LoadLEMTable(newValue);
0117   }
0118
0119   if (command == fCellLineCmd) {
0120     fRBE->SetCellLine(newValue);
0121   }
0122
0123   if (command == fResetCmd) {
0124     fRBE->Reset();
0125   }
0126
0127   if (command == fPrintCmd) {
0128     fRBE->PrintParameters();
0129   }
0130 }
0131
0132 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0133
0134 }  // namespace RadioBio