| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 /// \file optical/wls/include/WLSUserTrackInformation.hh
28 /// \brief Definition of the WLSUserTrackInformation class
29 //
30
31 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
32 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
33
34 #ifndef WLSUserTrackInformation_h
35 #define WLSUserTrackInformation_h 1
36
37 #include "G4ThreeVector.hh"
38 #include "G4VUserTrackInformation.hh"
39
40 enum TrackStatus
41 {
42 undefined = 0,
43 left = 1, // track is going -z
44 right = 2, // track is going +z
45 defined = 3, // left or right flag is on (Can't be Set)
46 EscapedFromSide = 4, // photon escaped through the side of the fiber
47 EscapedFromReadOut = 8, // photon escaped through read-out end of the fiber
48 ReflectedAtMirror = 16, // photon has been reflected by mirror at far end
49 ReflectedAtReadOut = 32, // photon has been reflected at the read-out end
50 murderee = 64, // photon is artificially killed
51 InsideOfFiber = 128, // Flag is on if the photon is inside of fiber
52 OutsideOfFiber = 256 // Flag is on if the photon is outside of fiber
53 };
54
55 class WLSUserTrackInformation : public G4VUserTrackInformation
56 {
57 public:
58 WLSUserTrackInformation() = default;
59 ~WLSUserTrackInformation() override = default;
60
61 const G4ThreeVector& GetExitPosition() const { return fExitPosition; }
62 void SetExitPosition(const G4ThreeVector& pos) { fExitPosition = pos; }
63
64 // Try adding a status flag and return if it is successful or not
65 // Cannot Add Undefine or a flag that conflicts with another flag
66 // Return true if the addition of flag is successful, false otherwise
67 G4bool AddStatusFlag(TrackStatus s);
68
69 // Check if a certain flag is on
70 G4bool IsStatus(TrackStatus s) { return s == undefined ? !(fStatus &= defined) : fStatus & s; }
71
72 private:
73 G4int fStatus = undefined;
74 G4ThreeVector fExitPosition;
75 };
76
77 #endif
78