Geant4  10.02.p01
G4StepPoint.hh
Go to the documentation of this file.
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 // $Id: G4StepPoint.hh 68795 2013-04-05 13:24:46Z gcosmo $
28 //
29 //
30 //---------------------------------------------------------------
31 //
32 // G4StepPoint.hh
33 //
34 // Class Description:
35 // This class represents information associated with the
36 // each end of a Step like the space/time data of the
37 // particle.
38 //
39 // Contact:
40 // Questions and comments to this code should be sent to
41 // Hisaya Kurashige
42 //
43 // ---------------------------------------------------------------
44 // Added fpMaterial 16 FEb. 2000 H.Kurahige
45 // Added fpMaterialCutsCouple 8 Oct. 2002 H.Kurahige
46 // Added fMagneticMoment Mar 2007 H.Kurashige
47 
48 #ifndef G4StepPoint_h
49 #define G4StepPoint_h 1
50 
51 #include <cmath> // Include from 'system'
52 #include <CLHEP/Units/PhysicalConstants.h>
53 
54 #include "globals.hh" // Include from 'global'
55 #include "G4Allocator.hh" // Include from 'global'
56 #include "G4ThreeVector.hh" // Include from 'geometry'
57 #include "G4VPhysicalVolume.hh" // Include from 'geometry'
58 class G4VProcess;
59 #include "G4SteppingControl.hh"
60 #include "G4StepStatus.hh" // Include from 'track'
61 #include "G4TouchableHandle.hh" // Include from 'geometry'
62 #include "G4Material.hh"
63 #include "G4LogicalVolume.hh"
64 
70 {
71 
72 //--------
73  public:
74 
75 
76 // Constructor/Destructor
77  G4StepPoint();
78 
80 
81 // Copy Counstructor and assignment operator
82  G4StepPoint(const G4StepPoint& );
83  G4StepPoint & operator=(const G4StepPoint &);
84 
85 //--------
86 
87  public: // with description
88 
89 // Get/Set functions
90  const G4ThreeVector& GetPosition() const;
91  void SetPosition(const G4ThreeVector& aValue);
92  void AddPosition(const G4ThreeVector& aValue);
93 
94  G4double GetLocalTime() const;
95  void SetLocalTime(const G4double aValue);
96  void AddLocalTime(const G4double aValue);
97  // Time since the track is created.
98 
99  G4double GetGlobalTime() const;
100  void SetGlobalTime(const G4double aValue);
101  void AddGlobalTime(const G4double aValue);
102  // Time since the event in which the track belongs is created.
103 
104  G4double GetProperTime() const;
105  void SetProperTime(const G4double aValue);
106  void AddProperTime(const G4double aValue);
107  // Proper time of the particle.
108 
109  const G4ThreeVector& GetMomentumDirection() const;
110  void SetMomentumDirection(const G4ThreeVector& aValue);
111  void AddMomentumDirection(const G4ThreeVector& aValue);
112  // Direction of momentum (should be an unit vector)
113 
114  G4ThreeVector GetMomentum() const;
115  // Total momentum of the track
116 
117 
118  G4double GetTotalEnergy() const;
119  // Total energy of the track
120 
121  G4double GetKineticEnergy() const;
122  void SetKineticEnergy(const G4double aValue);
123  void AddKineticEnergy(const G4double aValue);
124  // Kinetic Energy of the track
125 
126  G4double GetVelocity() const;
127  void SetVelocity(G4double v);
128  //
129 
130  G4double GetBeta() const;
131  // Velocity of the track in unit of c(light velocity)
132 
133  G4double GetGamma() const;
134  // Gamma factor (1/sqrt[1-beta*beta]) of the track
135 
137 
138  const G4VTouchable* GetTouchable() const;
139  const G4TouchableHandle& GetTouchableHandle() const;
140  void SetTouchableHandle(const G4TouchableHandle& apValue);
141 
142  G4Material* GetMaterial() const;
143  void SetMaterial(G4Material*);
144 
147 
150 
151  G4double GetSafety() const;
152  void SetSafety(const G4double aValue);
153 
154  const G4ThreeVector& GetPolarization() const;
155  void SetPolarization(const G4ThreeVector& aValue);
156  void AddPolarization(const G4ThreeVector& aValue);
157 
158  G4StepStatus GetStepStatus() const;
159  void SetStepStatus(const G4StepStatus aValue);
160 
161  const G4VProcess* GetProcessDefinedStep() const;
162  // If the pointer is 0, this means the Step is defined
163  // by the user defined limit in the current volume.
164  void SetProcessDefinedStep(const G4VProcess* aValue);
165 
166 
167  G4double GetMass() const;
168  void SetMass(G4double value);
169 
170  G4double GetCharge() const;
171  void SetCharge(G4double value);
172 
173  G4double GetMagneticMoment() const;
174  void SetMagneticMoment(G4double value);
175 
176  void SetWeight(G4double aValue);
177  G4double GetWeight() const;
178 
179 //---------
180  private:
181 //---------
182 
183 // Member data
186  // Time since event is created
188  // Time since track is created
190  // Time since track is created (in rest frame of particle)
194  // Momentum,energy and velocity
196  // Touchable Handle
198  // Material of the volmue
200  // MaterialCutsCouple of the volmue
205  // DoIt type which defined the current Step.
207  // Process which defined the current Step.
209  // Dynamical mass of the particle
211  // Dynamical Charge of the particle
213  // Dynamical MagneticMoment of the particle
215  // Track Weight
216 };
217 
218 #include "G4StepPoint.icc"
219 
220 #endif
G4double GetTotalEnergy() const
G4ThreeVector fMomentumDirection
Definition: G4StepPoint.hh:191
void AddGlobalTime(const G4double aValue)
void AddPosition(const G4ThreeVector &aValue)
void SetPosition(const G4ThreeVector &aValue)
G4double GetWeight() const
void SetProcessDefinedStep(const G4VProcess *aValue)
CLHEP::Hep3Vector G4ThreeVector
G4double fMagneticMoment
Definition: G4StepPoint.hh:212
void SetMagneticMoment(G4double value)
G4StepStatus GetStepStatus() const
G4Material * GetMaterial() const
G4ThreeVector fPosition
Definition: G4StepPoint.hh:184
void SetWeight(G4double aValue)
G4ThreeVector GetMomentum() const
G4double GetVelocity() const
const G4VTouchable * GetTouchable() const
const G4MaterialCutsCouple * GetMaterialCutsCouple() const
void SetStepStatus(const G4StepStatus aValue)
void AddLocalTime(const G4double aValue)
G4StepStatus
Definition: G4StepStatus.hh:49
G4double GetLocalTime() const
void SetGlobalTime(const G4double aValue)
void AddPolarization(const G4ThreeVector &aValue)
void SetMomentumDirection(const G4ThreeVector &aValue)
void SetLocalTime(const G4double aValue)
const G4ThreeVector & GetMomentumDirection() const
void SetSensitiveDetector(G4VSensitiveDetector *)
void SetPolarization(const G4ThreeVector &aValue)
G4VSensitiveDetector * fpSensitiveDetector
Definition: G4StepPoint.hh:201
G4VPhysicalVolume * GetPhysicalVolume() const
const G4ThreeVector & GetPosition() const
G4double fSafety
Definition: G4StepPoint.hh:202
G4TouchableHandle fpTouchable
Definition: G4StepPoint.hh:195
G4double GetCharge() const
G4ThreeVector fPolarization
Definition: G4StepPoint.hh:203
G4double fWeight
Definition: G4StepPoint.hh:214
G4double GetMass() const
G4double fGlobalTime
Definition: G4StepPoint.hh:185
void SetProperTime(const G4double aValue)
void AddKineticEnergy(const G4double aValue)
const G4VProcess * GetProcessDefinedStep() const
G4double fCharge
Definition: G4StepPoint.hh:210
void SetVelocity(G4double v)
void SetCharge(G4double value)
const G4MaterialCutsCouple * fpMaterialCutsCouple
Definition: G4StepPoint.hh:199
G4StepStatus fStepStatus
Definition: G4StepPoint.hh:204
G4double GetSafety() const
G4double GetProperTime() const
G4double fProperTime
Definition: G4StepPoint.hh:189
void SetMass(G4double value)
G4double GetGlobalTime() const
G4double GetMagneticMoment() const
G4VSensitiveDetector * GetSensitiveDetector() const
void SetMaterial(G4Material *)
G4double fMass
Definition: G4StepPoint.hh:208
G4double fKineticEnergy
Definition: G4StepPoint.hh:192
G4double GetKineticEnergy() const
double G4double
Definition: G4Types.hh:76
void SetSafety(const G4double aValue)
G4Material * fpMaterial
Definition: G4StepPoint.hh:197
void SetKineticEnergy(const G4double aValue)
G4double GetGamma() const
void SetTouchableHandle(const G4TouchableHandle &apValue)
void SetMaterialCutsCouple(const G4MaterialCutsCouple *)
G4StepPoint & operator=(const G4StepPoint &)
Definition: G4StepPoint.cc:85
G4double fVelocity
Definition: G4StepPoint.hh:193
const G4ThreeVector & GetPolarization() const
const G4TouchableHandle & GetTouchableHandle() const
G4double fLocalTime
Definition: G4StepPoint.hh:187
void AddMomentumDirection(const G4ThreeVector &aValue)
const G4VProcess * fpProcessDefinedStep
Definition: G4StepPoint.hh:206
void AddProperTime(const G4double aValue)
G4double GetBeta() const