include/Geant4/G4ParticleTableIterator.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 // G4ParticleTableIterator
0027
0028 // Authors: G.Cosmo, 2 December 1995 - Design, based on object model
0029 //          H.Kurashige, 28 October 1999 - First implementation
0030 // --------------------------------------------------------------------
0031 #ifndef G4ParticleTableIterator_hh
0032 #define G4ParticleTableIterator_hh 1
0033
0034 #include "G4ParticleDefinition.hh"
0035
0036 #include <map>
0037
0038 template<class K, class V>
0039 class G4ParticleTableIterator
0040 {
0041   public:
0042     using Map = std::map<K, V, std::less<K>>;
0043
0044     G4ParticleTableIterator(Map& adict) : it(adict.begin()), mydict(&adict) {}
0045
0046     G4bool operator++()
0047     {
0048       if (!defined) return false;
0049       ++it;
0050       return static_cast<bool>(it != mydict->end());
0051     }
0052
0053     G4bool operator()()
0054     {
0055       if (!defined) {
0056         defined = true;
0057         it = mydict->begin();
0058       }
0059       else {
0060         ++it;
0061       }
0062       if (it == mydict->end()) return false;
0063       if (skipIons) {
0064         while ((static_cast<G4ParticleDefinition*>((*it).second))->IsGeneralIon())
0065         {  // Loop checking, 09.08.2015, K.Kurashige
0066           ++it;
0067           if (it == mydict->end()) return false;
0068         }
0069       }
0070       return true;
0071     }
0072
0073     void reset(G4bool ifSkipIon = true)
0074     {
0075       defined = false;
0076       skipIons = ifSkipIon;
0077     }
0078
0079     K* key() const { return &((*it).first); }
0080
0081     V value() const { return (*it).second; }
0082
0083   private:
0084     typename Map::iterator it;
0085     Map* mydict = nullptr;
0086     G4bool defined = false;
0087     G4bool skipIons = true;
0088 };
0089
0090 #endif