include/Geant4/G4VHitsCollection.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 // G4VHitsCollection
0027 //
0028 // Class description:
0029 //
0030 // This is the base class of hits collection. The user is advised to
0031 // use G4THitsCollection template class in case his/her collection is
0032 // transient. While, in case the collection is persistent,
0033 // the concrete collection class can be directly derived from this
0034 // class. Geant4 kernel will use this class methods.
0035 //
0036 // Author: Makoto Asai
0037 // --------------------------------------------------------------------
0038 #ifndef G4VHitsCollection_h
0039 #define G4VHitsCollection_h 1
0040
0041 #include "globals.hh"
0042
0043 class G4VHit;
0044
0045 class G4VHitsCollection
0046 {
0047  public:
0048
0049   G4VHitsCollection() = default;
0050   G4VHitsCollection(const G4String& detName, const G4String& colNam);
0051   virtual ~G4VHitsCollection() = default;
0052   G4bool operator==(const G4VHitsCollection& right) const;
0053
0054   virtual void DrawAllHits(){};
0055   virtual void PrintAllHits(){};
0056
0057   inline const G4String& GetName() const { return collectionName; }
0058   inline const G4String& GetSDname() const { return SDname; }
0059   inline void SetColID(G4int i) { colID = i; }
0060   inline G4int GetColID() const { return colID; }
0061
0062   // GetHit and GetSize are given a default implementation here so
0063   // that the template G4THitsCollection can be used, but they
0064   // are re-implemented G4THitsCollection.
0065   virtual G4VHit* GetHit(std::size_t) const { return nullptr; }
0066   virtual std::size_t GetSize() const { return 0; };
0067
0068  protected:
0069
0070   // Collection name
0071   G4String collectionName = "Unknown";
0072   G4String SDname = "Unknown";
0073   // Collection ID
0074   G4int colID = -1;
0075 };
0076
0077 #endif