include/Geant4/G4HCtable.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 // G4HCtable
0027 //
0028 // Class description:
0029 //
0030 // This class is used by G4SDManager for book keeping the
0031 // sensitive detector modules and hits collections. The order of
0032 // hits collections stored in G4HCofThisEvent is same as the
0033 // order of HClist.
0034 // The order may vary from run to run, if the user adds/changes
0035 // some of his/her sensitive detector modules.
0036 // In case user wants to make G4Run object persistent, this
0037 // G4HCtable class object should be copied and stored with
0038 // G4Run object.
0039 //
0040 // Author: Makoto Asai
0041 // ---------------------------------------------------------------------
0042 #ifndef G4HCtable_H
0043 #define G4HCtable_H 1
0044
0045 #include "globals.hh"
0046
0047 #include <vector>
0048
0049 class G4VSensitiveDetector;
0050
0051 class G4HCtable
0052 {
0053  public:
0054   G4HCtable() = default;
0055   ~G4HCtable() = default;
0056
0057  public:
0058   G4int Registor(const G4String& SDname, const G4String& HCname);
0059   G4int GetCollectionID(const G4String& HCname) const;
0060   G4int GetCollectionID(G4VSensitiveDetector* aSD) const;
0061
0062   inline G4int entries() const { return G4int(HClist.size()); }
0063
0064   inline G4String GetSDname(G4int i) const
0065   {
0066     if (i < 0 || i > entries()) return "***Not Defined***";
0067     return SDlist[i];
0068   }
0069
0070   inline G4String GetHCname(G4int i) const
0071   {
0072     if (i < 0 || i > entries()) return "***Not Defined***";
0073     return HClist[i];
0074   }
0075
0076  private:
0077   std::vector<G4String> SDlist;
0078   std::vector<G4String> HClist;
0079 };
0080
0081 #endif