| 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 //
28 //
29 // Class Description:
30 //
31 // Base class for the trajectory state
32
33 // History:
34 // - Created: P. Arce
35 // --------------------------------------------------------------------
36
37 #ifndef G4ErrorTrajState_hh
38 #define G4ErrorTrajState_hh
39
40 #include "globals.hh"
41 #include "G4Track.hh"
42 #include "G4Point3D.hh"
43 #include "G4Vector3D.hh"
44 #include "G4ErrorTrajErr.hh"
45
46 enum G4eTSType
47 {
48 G4eTS_FREE,
49 G4eTS_OS
50 };
51
52 class G4ErrorTrajState
53 {
54 public: // with description
55 G4ErrorTrajState()
56 : fCharge(0.)
57 , theG4Track(0)
58 , iverbose(0)
59 {}
60
61 G4ErrorTrajState(const G4String& partType, const G4Point3D& pos,
62 const G4Vector3D& mom,
63 const G4ErrorTrajErr& errmat = G4ErrorTrajErr(5, 0));
64 // Constructor by providing particle, position and momentum
65
66 G4ErrorTrajState(const G4ErrorTrajState&);
67 G4ErrorTrajState(G4ErrorTrajState&&);
68 // The copy and move constructors
69
70 virtual ~G4ErrorTrajState() {}
71
72 G4ErrorTrajState& operator=(const G4ErrorTrajState&);
73 G4ErrorTrajState& operator=(G4ErrorTrajState&&);
74 // The copy and move assignment operators
75
76 void SetData(const G4String& partType, const G4Point3D& pos,
77 const G4Vector3D& mom);
78 // Set particle, position and momentum
79
80 void BuildCharge();
81 // Build charge based on particle type
82
83 friend std::ostream& operator<<(std::ostream&, const G4ErrorTrajState& ts);
84
85 virtual G4int PropagateError(const G4Track*);
86 // Propagate the error along the step
87
88 virtual G4int Update(const G4Track*) { return -1; }
89 // Update parameters from G4Track
90
91 void UpdatePosMom(const G4Point3D& pos, const G4Vector3D& mom);
92 // Update position and momentum
93
94 void DumpPosMomError(std::ostream& out = G4cout) const;
95 // Dump position, momentum and error
96
97 virtual void Dump(std::ostream& out = G4cout) const = 0;
98 // Abstract method to dump all TrajState parameters
99
100 // Set and Get methods
101
102 const G4String& GetParticleType() const { return fParticleType; }
103 void SetParticleType(const G4String& partType) { fParticleType = partType; }
104
105 G4Point3D GetPosition() const { return fPosition; }
106 virtual void SetPosition(const G4Point3D pos) { fPosition = pos; }
107
108 G4Vector3D GetMomentum() const { return fMomentum; }
109 virtual void SetMomentum(const G4Vector3D& mom) { fMomentum = mom; }
110
111 G4ErrorTrajErr GetError() const { return fError; }
112 virtual void SetError(G4ErrorTrajErr em) { fError = em; }
113
114 G4Track* GetG4Track() const { return theG4Track; }
115 void SetG4Track(G4Track* trk) { theG4Track = trk; }
116
117 G4double GetCharge() const { return fCharge; }
118 void SetCharge(G4double ch) { fCharge = ch; }
119
120 virtual G4eTSType GetTSType() const { return theTSType; }
121
122 protected:
123 G4String fParticleType;
124 G4Point3D fPosition;
125 G4Vector3D fMomentum;
126 G4double fCharge = 0.;
127 G4ErrorTrajErr fError;
128
129 G4eTSType theTSType;
130
131 G4Track* theG4Track = nullptr;
132
133 G4int iverbose = 0;
134 };
135
136 #endif
137