LXe/include/LXeUserTrackInformation.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 optical/LXe/include/LXeUserTrackInformation.hh
0028 /// \brief Definition of the LXeUserTrackInformation class
0029 //
0030 #include "G4VUserTrackInformation.hh"
0031 #include "globals.hh"
0032
0033 #ifndef LXeUserTrackInformation_h
0034 #  define LXeUserTrackInformation_h 1
0035
0036 enum LXeTrackStatus
0037 {
0038   active = 1,
0039   hitPMT = 2,
0040   absorbed = 4,
0041   boundaryAbsorbed = 8,
0042   hitSphere = 16,
0043   inactive = 14
0044 };
0045
0046 /*LXeTrackStatus:
0047   active: still being tracked
0048   hitPMT: stopped by being detected in a PMT
0049   absorbed: stopped by being absorbed with G4OpAbsorbtion
0050   boundaryAbsorbed: stopped by being aborbed with G4OpAbsorbtion
0051   hitSphere: track hit the sphere at some point
0052   inactive: track is stopped for some reason
0053    -This is the sum of all stopped flags so can be used to remove stopped flags
0054
0055 */
0056
0057 class LXeUserTrackInformation : public G4VUserTrackInformation
0058 {
0059   public:
0060     LXeUserTrackInformation() = default;
0061     ~LXeUserTrackInformation() override = default;
0062
0063     // Sets the track status to s (does not check validity of flags)
0064     void SetTrackStatusFlags(int s) { fStatus = s; }
0065     // Does a smart add of track status flags (disabling old flags that conflict)
0066     // If s conflicts with itself it will not be detected
0067     void AddTrackStatusFlag(int s);
0068
0069     int GetTrackStatus() const { return fStatus; }
0070
0071     void IncReflections() { ++fReflections; }
0072     G4int GetReflectionCount() const { return fReflections; }
0073
0074     void SetForceDrawTrajectory(G4bool b) { fForcedraw = b; }
0075     G4bool GetForceDrawTrajectory() { return fForcedraw; }
0076
0077     inline virtual void Print() const override {};
0078
0079   private:
0080     int fStatus = active;
0081     G4int fReflections = 0;
0082     G4bool fForcedraw = false;
0083 };
0084
0085 #endif