BDSAcceleratorComponentRegistry.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2024.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSACCELERATORCOMPONENTREGISTRY_H
#define BDSACCELERATORCOMPONENTREGISTRY_H
 
#include "globals.hh" // geant4 globals / types
 
#include <functional>  // for all the std::hash business
#include <iterator>
#include <map>
#include <set>
#include <string>
#include <unordered_map>
 
class BDSAcceleratorComponent;
 
class ACRegistryKey
{
public:
  ACRegistryKey();
  ACRegistryKey(const std::string& componentNameIn, G4double rigidityIn);
  ~ACRegistryKey() = default;
  ACRegistryKey(const ACRegistryKey& other) = default;
  bool operator==(const ACRegistryKey& other) const;
  friend std::ostream& operator<<(std::ostream &out, ACRegistryKey const &k);
  
  std::string componentName; 
  G4double rigidity;
  static G4double tolerance;
};
 
namespace std
{
  template <>
  struct hash<ACRegistryKey>
  {
    std::size_t operator()(const ACRegistryKey& k) const
    {
      std::size_t h1 = std::hash<std::string>()(k.componentName);
      std::size_t h2 = std::hash<double>()(k.rigidity);
      std::size_t ht = h1 ^ (h2 + 0x9e3779b9 + (h1<<6) + (h1>>2)); 
      return ht;
    }
  };
}
 
class BDSAcceleratorComponentRegistry
{
private:
  // Typedefs up first so we can declare public iterators.
  typedef std::unordered_map<ACRegistryKey, BDSAcceleratorComponent*> RegistryMap;
 
  RegistryMap registry;
 
  RegistryMap registryForAllocated;
  
public:
  static BDSAcceleratorComponentRegistry* Instance();
 
  ~BDSAcceleratorComponentRegistry();
 
  void RegisterComponent(BDSAcceleratorComponent* component,
                         G4double                 rigidtyAtConstructionTime,
                         bool                     isModified = false);
 
  G4bool IsRegistered(BDSAcceleratorComponent* component, G4double rigidtyAtConstructionTime);
 
  G4bool IsRegistered(const G4String& componentName, G4double rigidtyAtConstructionTime);
 
  G4bool IsRegisteredAllocated(const BDSAcceleratorComponent* componentName) const;
 
  BDSAcceleratorComponent* GetComponent(const G4String& name, G4double rigidtyAtConstructionTime);
 
  void RegisterCurvilinearComponent(BDSAcceleratorComponent* component);
 
  void RegisterTunnelComponent(BDSAcceleratorComponent* component);
 
  std::unordered_map<ACRegistryKey, BDSAcceleratorComponent*> AllComponentsIncludingUnique() const;
  
  G4int AlreadyRegisteredNameCount(const G4String& name) const;
 
  typedef RegistryMap::iterator       iterator;
  typedef RegistryMap::const_iterator const_iterator;
  iterator       begin()       {return registry.begin();}
  iterator       end()         {return registry.end();}
  const_iterator begin() const {return registry.begin();}
  const_iterator end()   const {return registry.end();}
  G4bool         empty() const {return registry.empty();}
 
  size_t size() const {return registry.size();}
  
  friend std::ostream& operator<<(std::ostream &out, BDSAcceleratorComponentRegistry const &r);
 
  void PrintNumberOfEachType() const;
 
private:
  BDSAcceleratorComponentRegistry();
  
  static BDSAcceleratorComponentRegistry* instance;
 
  BDSAcceleratorComponentRegistry& operator=(const BDSAcceleratorComponentRegistry&);
  BDSAcceleratorComponentRegistry(BDSAcceleratorComponentRegistry&);
 
  std::set<BDSAcceleratorComponent*> allocatedComponents;
  
  std::set<BDSAcceleratorComponent*> curvilinearComponents;
 
  std::set<BDSAcceleratorComponent*> tunnelComponents;
 
  std::unordered_map<std::string, int> typeCounter;
  
  std::unordered_map<std::string, int> nameCounter;
};
 
#endif