include/Geant4/G4ParticleMessenger.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 // G4ParticleMessenger
0027 //
0028 // Class description:
0029 //
0030 // This is a messenger class to exchange information between particle
0031 // related classes and UI.
0032 //
0033 // List of Directory and Commands:
0034 //
0035 // G4ParticleMessenger
0036 //  /particle/   Particle control commands.
0037 //   Commands :
0038 //    select * Select particle
0039 //    list * List name of particles.
0040 //    find * find particle by PDG encoding.
0041 //    verbose * Set Verbose level of Particle Table
0042 //
0043 // G4ParticlePropertyMessenger
0044 //  /particle/property/   Particle Table control commands.
0045 //   Commands :
0046 //     dump * dump particle properties.
0047 //     stable * Set stable flag.
0048 //     lifetime * Set life time.
0049 //     verbose * Set Verbose level
0050 //
0051 // G4DecayTableMessenger
0052 //  /particle/property/decay/   Decay Table control commands.
0053 //   Commands :
0054 //     select * Enter index of decay mode.
0055 //     dump * Dump decay mode information.
0056 //     br * Set branching ratio. [0< BR <1.0]
0057
0058 // Author: H. Kurashige, 13 June 1997 - 1st version created
0059 // --------------------------------------------------------------------
0060 #ifndef G4ParticleMessenger_hh
0061 #define G4ParticleMessenger_hh 1
0062
0063 #include "G4UImessenger.hh"
0064 #include "globals.hh"
0065
0066 class G4ParticleDefinition;
0067 class G4ParticleTable;
0068 class G4ParticlePropertyMessenger;
0069
0070 class G4UIdirectory;
0071 class G4UIcmdWithAString;
0072 class G4UIcmdWithAnInteger;
0073 class G4UIcmdWithoutParameter;
0074
0075 class G4ParticleMessenger : public G4UImessenger
0076 {
0077   public:
0078     G4ParticleMessenger(G4ParticleTable* pTable = nullptr);
0079     ~G4ParticleMessenger() override;
0080
0081     G4ParticleMessenger(const G4ParticleMessenger&) = delete;
0082     G4ParticleMessenger& operator=(const G4ParticleMessenger&) = delete;
0083
0084     void SetNewValue(G4UIcommand* command, G4String newValues) override;
0085     G4String GetCurrentValue(G4UIcommand* command) override;
0086
0087   private:
0088     G4UIdirectory* thisDirectory = nullptr;
0089     G4UIcmdWithAString* listCmd = nullptr;
0090     G4UIcmdWithAString* selectCmd = nullptr;
0091     G4UIcmdWithAnInteger* findCmd = nullptr;
0092     G4UIcmdWithoutParameter* createAllIonCmd = nullptr;
0093     G4UIcmdWithoutParameter* createAllIsomerCmd = nullptr;
0094     G4UIcmdWithAnInteger* verboseCmd = nullptr;
0095
0096     G4ParticleTable* theParticleTable = nullptr;
0097
0098     G4ParticlePropertyMessenger* fParticlePropertyMessenger = nullptr;
0099 };
0100
0101 #endif