include/Geant4/G4VParticlePropertyReporter.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 #ifndef G4VParticlePropertyReporter_h
0027 #define G4VParticlePropertyReporter_h 1
0028
0029 #include "G4ParticlePropertyData.hh"
0030 #include "G4ParticlePropertyTable.hh"
0031 #include "globals.hh"
0032
0033 #include <vector>
0034
0035 class G4VParticlePropertyReporter
0036 {
0037   public:
0038     using G4PPDContainer = std::vector<G4ParticlePropertyData*>;
0039
0040   public:
0041     // constructors
0042     G4VParticlePropertyReporter();
0043
0044     // destructor
0045     virtual ~G4VParticlePropertyReporter();
0046
0047     // equality operators
0048     G4bool operator==(const G4VParticlePropertyReporter& right) const { return (this == &right); }
0049
0050     G4bool operator!=(const G4VParticlePropertyReporter& right) const { return (this != &right); }
0051
0052     // fill out properties for specified particle type/name
0053     // (return false if specified name/type does not exist)
0054     virtual G4bool FillList(G4String name);
0055
0056     // clear the list
0057     virtual void Clear();
0058
0059     // print out particle properties in the list
0060     virtual void Print(const G4String& option) = 0;
0061
0062     const G4PPDContainer& GetList() const { return pList; }
0063
0064   protected:
0065     G4PPDContainer pList;
0066     G4ParticlePropertyTable* pPropertyTable;
0067 };
0068
0069 #endif