include/Geant4/G4TrackTerminator.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 //
0028 // ----------------------------------------------------------------------
0029 // Class G4TrackTerminator
0030 //
0031 // Class description:
0032 //
0033 // This is an interface for an object which can be called to kill a track.
0034 // The type it provides is needed in case importance biasing and scoring
0035 // is done at the same time.
0036 // For navigation in the parallel geometry which is done by the importance
0037 // biasing process (it derives from G4ParallelTransport), importance
0038 // biasing has to be done before scoring (to score the correct volume).
0039 // But since scoring would not be called if the importance biasing kills
0040 // a track, it only tells a G4TrackTerminator to kill the track.
0041 // The scoring process implements the interface G4TrackTerminator
0042 // and is now able to kill the track after it has performed the scoring.
0043
0044 // Author: Michael Dressel (Michael.Dressel@cern.ch)
0045 // ----------------------------------------------------------------------
0046 #ifndef G4TrackTerminator_hh
0047 #define G4TrackTerminator_hh G4TrackTerminator_hh
0048
0049 #include "G4Types.hh"
0050
0051 class G4TrackTerminator
0052 {
0053
0054 public:  // without description
0055
0056   G4TrackTerminator()
0057     : fKillTrack(false) {}
0058   ~G4TrackTerminator();
0059
0060   void SetKillTrack(){fKillTrack = true;}
0061   G4bool GetKillTrack() const {return fKillTrack;}
0062
0063 private:
0064
0065   G4bool fKillTrack;
0066 };
0067
0068 #endif