BDSPhysicalVolumeInfoRegistry.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
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 BDSPHYSICALVOLUMEINFOREGISTRY_H
#define BDSPHYSICALVOLUMEINFOREGISTRY_H
 
#include "globals.hh" // geant4 globals / types
 
#include <iterator>
#include <map>
#include <set>
 
class G4VPhysicalVolume;
class BDSBeamlineElement;
class BDSPhysicalVolumeInfo;
 
typedef std::map<G4VPhysicalVolume*, BDSPhysicalVolumeInfo*>::iterator BDSPVInfoIterator;
typedef std::map<G4VPhysicalVolume*, BDSPhysicalVolumeInfo*>::const_iterator BDSPVInfoIteratorConst;
 
class BDSPhysicalVolumeInfoRegistry
{
public:
  static BDSPhysicalVolumeInfoRegistry* Instance();
 
  ~BDSPhysicalVolumeInfoRegistry();
 
  void RegisterInfo(G4VPhysicalVolume*     physicalVolume,
                    BDSPhysicalVolumeInfo* info,
                    G4bool                 isReadOutVolume = false,
                    G4bool                 isTunnel = false);
  
  void RegisterInfo(const std::set<G4VPhysicalVolume*>& physicalVolumes,
                    BDSPhysicalVolumeInfo* info,
                    G4bool                 isReadOutVolume = false,
                    G4bool                 isTunnel = false);
 
  BDSPhysicalVolumeInfo* GetInfo(G4VPhysicalVolume* logicalVolume,
                                 G4bool             isTunnel = false);
 
  void RegisterExcludedPV(G4VPhysicalVolume* physicalVolume);
 
  void RegisterPVsForOutput(const BDSBeamlineElement* element,
                            const std::set<G4VPhysicalVolume*>& physicalVolumes);
 
  friend std::ostream& operator<< (std::ostream &out, BDSPhysicalVolumeInfoRegistry const &r);
  
  const std::set<G4VPhysicalVolume*>* PVsForBeamlineElement(BDSBeamlineElement* element) const;
 
private:
  BDSPhysicalVolumeInfoRegistry();
 
  G4bool IsRegistered(G4VPhysicalVolume* physicalVolume);
 
  G4bool IsRegisteredToReadOutRegister(G4VPhysicalVolume* physicalVolume);
 
  G4bool IsRegisteredToBackupRegister(G4VPhysicalVolume* physicalVolume);
 
  // Check whether a physical volume is registered ot the tunnel registry
  G4bool IsRegisteredToTunnelRegister(G4VPhysicalVolume* physicalVolume);
 
  BDSPVInfoIterator readOutSearch;
  BDSPVInfoIterator backupSearch;
  BDSPVInfoIterator tunnelSearch;
  
  static BDSPhysicalVolumeInfoRegistry* instance;
 
  std::map<G4VPhysicalVolume*, BDSPhysicalVolumeInfo*> readOutRegister;
  std::map<G4VPhysicalVolume*, BDSPhysicalVolumeInfo*> backupRegister;
  std::map<G4VPhysicalVolume*, BDSPhysicalVolumeInfo*> tunnelRegister;
  std::set<G4VPhysicalVolume*> excludedVolumes;
  
  std::set<BDSPhysicalVolumeInfo*> pvInfosForDeletion;
 
  std::map<const BDSBeamlineElement*, std::set<G4VPhysicalVolume*> > pvsForAGivenElement;
};
 
 
 
 
 
 
#endif