LXeUserTrackInformation.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
/// \file optical/LXe/include/LXeUserTrackInformation.hh
/// \brief Definition of the LXeUserTrackInformation class
//
#include "G4VUserTrackInformation.hh"
#include "globals.hh"
 
#ifndef LXeUserTrackInformation_h
#  define LXeUserTrackInformation_h 1
 
enum LXeTrackStatus
{
  active           = 1,
  hitPMT           = 2,
  absorbed         = 4,
  boundaryAbsorbed = 8,
  hitSphere        = 16,
  inactive         = 14
};
 
/*LXeTrackStatus:
  active: still being tracked
  hitPMT: stopped by being detected in a PMT
  absorbed: stopped by being absorbed with G4OpAbsorbtion
  boundaryAbsorbed: stopped by being aborbed with G4OpAbsorbtion
  hitSphere: track hit the sphere at some point
  inactive: track is stopped for some reason
   -This is the sum of all stopped flags so can be used to remove stopped flags
 
*/
 
class LXeUserTrackInformation : public G4VUserTrackInformation
{
 public:
  LXeUserTrackInformation() = default;
  ~LXeUserTrackInformation() override = default;
 
  // Sets the track status to s (does not check validity of flags)
  void SetTrackStatusFlags(int s) { fStatus = s; }
  // Does a smart add of track status flags (disabling old flags that conflict)
  // If s conflicts with itself it will not be detected
  void AddTrackStatusFlag(int s);
 
  int GetTrackStatus() const { return fStatus; }
 
  void IncReflections() { ++fReflections; }
  G4int GetReflectionCount() const { return fReflections; }
 
  void SetForceDrawTrajectory(G4bool b) { fForcedraw = b; }
  G4bool GetForceDrawTrajectory() { return fForcedraw; }
 
  inline virtual void Print() const override {};
 
 private:
  int fStatus = active;
  G4int fReflections = 0;
  G4bool fForcedraw = false;
};
 
#endif