composite_calorimeter/include/CCalHit.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 // File: CCalHit.h
0028 // Description: Hit class for Calorimeters (Ecal, Hcal, ...)
0029 //
0030 // One Hit object should be created
0031 // -for each new particle entering the calorimeter
0032 // -for each detector unit (= cristal or fiber or scintillator layer)
0033 // -for each nanosecond of the shower development
0034 //
0035 // This implies that all hit objects created for a given shower
0036 // have the same value for
0037 // - Entry (= local coordinates of the entrance point of the particle
0038 //            in the unit where the shower starts)
0039 // - the TrackID (= Identification number of the incident particle)
0040 // - the IncidentEnergy (= energy of that particle)
0041 //
0042 ///////////////////////////////////////////////////////////////////////////////
0043
0044 #ifndef CCalHit_h
0045 #define CCalHit_h 1
0046
0047 #include <iostream>
0048 #include <CLHEP/Vector/ThreeVector.h>
0049 #include "globals.hh"
0050
0051
0052 class CCalHit {
0053
0054   friend std::ostream& operator<< (std::ostream&, const CCalHit&);
0055
0056 public:
0057
0058   CCalHit();
0059   ~CCalHit();
0060   CCalHit(const CCalHit &right);
0061   const CCalHit& operator=(const CCalHit &right);
0062   G4bool operator==(const CCalHit &){return false;}
0063
0064   void print();
0065
0066 public:
0067
0068   CLHEP::Hep3Vector   getEntry() const;
0069   void         setEntry(CLHEP::Hep3Vector xyz);
0070
0071   G4double     getIncidentEnergy() const;
0072   void         setIncidentEnergy (G4double e);
0073
0074   G4int        getTrackID() const;
0075   void         setTrackID (G4int i);
0076
0077   unsigned int getUnitID() const;
0078   void         setUnitID (unsigned int i);
0079
0080   G4double       getTimeSlice() const;
0081   void         setTimeSlice(G4double d);
0082   G4int          getTimeSliceID() const;
0083
0084   G4double     getEnergyDeposit() const;
0085   void         setEnergyDeposit(const G4double e);
0086   void         addEnergyDeposit(const CCalHit& aHit);
0087   void         addEnergyDeposit(const G4double e);
0088
0089 private:
0090
0091   CLHEP::Hep3Vector   entry;        // Entry point
0092   G4double       theIncidentEnergy; // Energy of the primary particle
0093   G4int          theTrackID;        // Identification number of the primary particle
0094   unsigned int theUnitID;           // Calorimeter Unit Number
0095   G4double       theTimeSlice;      // Time Slice Identification
0096   G4double       theEnergyDeposit;  // Cumulated Energy deposit
0097
0098 };
0099
0100 #endif