include/Geant4/G4TypeKey.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 //
0027 // Base type key class
0028 //
0029 // Jane Tinslay, September 2006
0030 //
0031 #ifndef G4TYPEKEY_HH
0032 #define G4TYPEKEY_HH
0033
0034 #include "globals.hh"
0035 #include <ostream>
0036
0037 class G4TypeKey {
0038
0039 public:
0040
0041   using Key = unsigned long;
0042
0043   // Constructor
0044   G4TypeKey() = default;
0045
0046   // Destructor
0047   virtual ~G4TypeKey() = default;
0048
0049   G4bool IsValid() {
0050     return (0 != fMyKey);
0051   }
0052
0053   // Operators
0054   Key operator()() const {return fMyKey;}
0055   G4bool operator==(const G4TypeKey& rhs) const {return fMyKey == rhs.fMyKey;}
0056   G4bool operator!=(const G4TypeKey& rhs) const {return !operator==(rhs);}
0057   G4bool operator<(const G4TypeKey& rhs) const {return fMyKey < rhs.fMyKey;}
0058   G4bool operator>(const G4TypeKey& rhs) const {return fMyKey > rhs.fMyKey;}
0059
0060   friend std::ostream& operator<<(std::ostream& out, const G4TypeKey& key){
0061     return out<< key.fMyKey;
0062   }
0063
0064 protected:
0065
0066   Key NextKey() const {
0067     static G4ThreadLocal Key *npKey = nullptr ;
0068     if (npKey == nullptr) { npKey = new Key; *npKey = 0; }
0069     Key &nKey = *npKey;
0070     return ++nKey;
0071   }
0072
0073   Key fMyKey{0};
0074
0075 };
0076
0077 #endif