hadrontherapy/include/HadrontherapyAnalysisFileMessenger.hh

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 // Hadrontherapy advanced example for Geant4
0027 // See more at: https://twiki.cern.ch/twiki/bin/view/Geant4/AdvancedExamplesHadrontherapy
0028
0029 #ifndef HadrontherapyAnalysisFileMessenger_h
0030 #define HadrontherapyAnalysisFileMessenger_h 1
0031
0032
0033 #include "G4UImessenger.hh"
0034 #include "globals.hh"
0035
0036 class HadrontherapyAnalysis; ///< Provides SetanalysisFileName()
0037 class G4UIcmdWithAString;
0038 class G4UIcmdWithABool;
0039
0040 /**
0041  * A messenger object of this class is created by the AnalysisManager.
0042  * The point of a messenger is to connect the G4UI with the simulation
0043  * functionality.
0044  * The messenger needs to contain a command object and to have SetValue
0045  * method that is called once a command is set.
0046  *
0047  * @see HadrontherapyAnalysisManager
0048  */
0049 class HadrontherapyAnalysisFileMessenger: public G4UImessenger
0050 {
0051 public:
0052   HadrontherapyAnalysisFileMessenger(HadrontherapyAnalysis*);
0053   ~HadrontherapyAnalysisFileMessenger();
0054
0055   /**
0056    * Called when new command given.
0057    * @param command is a pointer to the given command object
0058    * @param newValue holds the argument given as a G4String
0059    * @return is void
0060    */
0061   void SetNewValue(G4UIcommand* command, G4String newValue);
0062   HadrontherapyAnalysis* AnalysisManager; ///< handle to AnalysisManager
0063
0064 private:
0065
0066   /**
0067    * G4 user interface command (that takes a string argument) object
0068    * Constructor requires command name and messenger class(this).
0069    */
0070   G4UIcmdWithABool *LetCmd, *secondaryCmd;
0071   G4UIcmdWithAString *DoseMatrixCmd;
0072
0073 };
0074
0075 #endif