include/Geant4/G4ParticleGunMessenger.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 // G4ParticleGunMessenger
0027 //
0028 // Class description:
0029 //
0030 // This is a concrete class of G4UImessenger which handles commands for
0031 // G4ParticleGun.
0032
0033 // Author: Makoto Asai, 1997
0034 // --------------------------------------------------------------------
0035 #ifndef G4ParticleGunMessenger_hh
0036 #define G4ParticleGunMessenger_hh 1
0037
0038 #include "globals.hh"
0039 #include "G4UImessenger.hh"
0040
0041 class G4ParticleGun;
0042 class G4ParticleTable;
0043 class G4UIcommand;
0044 class G4UIdirectory;
0045 class G4UIcmdWithoutParameter;
0046 class G4UIcmdWithAString;
0047 class G4UIcmdWithADoubleAndUnit;
0048 class G4UIcmdWith3Vector;
0049 class G4UIcmdWith3VectorAndUnit;
0050 class G4UIcmdWithAnInteger;
0051 class G4UIcmdWithABool;
0052
0053 class G4ParticleGunMessenger : public G4UImessenger
0054 {
0055   public:
0056
0057     explicit G4ParticleGunMessenger(G4ParticleGun* fPtclGun);
0058     ~G4ParticleGunMessenger() override;
0059
0060     void SetNewValue(G4UIcommand* command, G4String newValues) override;
0061     G4String GetCurrentValue(G4UIcommand* command) override;
0062
0063   private:
0064
0065     void IonCommand(const G4String& newValues);
0066     void IonLevelCommand(const G4String& newValues);
0067
0068   private:
0069
0070     G4ParticleGun* fParticleGun = nullptr; // Not owned, cannot be null post construction
0071     G4ParticleTable* particleTable = nullptr;
0072
0073     // Commands
0074     //
0075     G4UIdirectory*              gunDirectory;
0076     G4UIcmdWithoutParameter*    listCmd;
0077     G4UIcmdWithAString*         particleCmd;
0078     G4UIcmdWith3Vector*         directionCmd;
0079     G4UIcmdWithADoubleAndUnit*  energyCmd;
0080     G4UIcmdWithADoubleAndUnit*  momAmpCmd;
0081     G4UIcmdWith3VectorAndUnit*  momCmd;
0082     G4UIcmdWith3VectorAndUnit*  positionCmd;
0083     G4UIcmdWithADoubleAndUnit*  timeCmd;
0084     G4UIcmdWith3Vector*         polCmd;
0085     G4UIcmdWithAnInteger*       numberCmd;
0086     G4UIcommand*                ionCmd;
0087     G4UIcommand*                ionLvlCmd;
0088     G4UIcmdWithABool*           volChkCmd;
0089
0090     // For ion shooting
0091     //
0092     G4bool   fShootIon = false;
0093     G4int    fAtomicNumber = 0;
0094     G4int    fAtomicMass = 0;
0095     G4int    fIonCharge = 0;
0096     G4double fIonExciteEnergy = 0.0;
0097     char     fIonFloatingLevelBase = '\0';
0098     G4int    fIonEnergyLevel = 0;
0099 };
0100
0101 #endif