| 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 // G4VTrajectory
27 //
28 // Class description:
29 //
30 // This class is the abstract base class representing a trajectory of
31 // a particle being tracked.
32 // Its concrete class includes information of:
33 // 1) List of trajectory points composing the trajectory;
34 // 2) Static information of the particle which generated the trajectory;
35 // 3) Track ID and parent particle ID of the trajectory.
36
37 // Contact:
38 // Questions and comments to this code should be sent to
39 // Katsuya Amako (e-mail: Katsuya.Amako@kek.jp)
40 // Makoto Asai (e-mail: asai@slac.stanford.edu)
41 // Takashi Sasaki (e-mail: Takashi.Sasaki@kek.jp)
42 // --------------------------------------------------------------------
43 #ifndef G4VTrajectory_hh
44 #define G4VTrajectory_hh 1
45
46 #include "G4ThreeVector.hh"
47 #include "globals.hh"
48
49 #include <map>
50 #include <vector>
51
52 class G4Step;
53 class G4VTrajectoryPoint;
54 class G4AttDef;
55 class G4AttValue;
56
57 class G4VTrajectory
58 {
59 public:
60 // Constructor/Destrcutor
61 G4VTrajectory() = default;
62 virtual ~G4VTrajectory() = default;
63
64 // Equality operator
65 G4bool operator==(const G4VTrajectory& right) const;
66
67 // Cloning with the master thread allocator
68 // Each concrete class should implement its own method.
69 // This method is used only in the sub-event parallel mode.
70 virtual G4VTrajectory* CloneForMaster() const;
71
72 // Accessors
73 virtual G4int GetTrackID() const = 0;
74 virtual G4int GetParentID() const = 0;
75 virtual G4String GetParticleName() const = 0;
76
77 // Charge is that of G4DynamicParticle
78 virtual G4double GetCharge() const = 0;
79
80 // Zero will be returned if the particle does not have PDG code.
81 virtual G4int GetPDGEncoding() const = 0;
82
83 // Momentum at the origin of the track in global coordinate system
84 virtual G4ThreeVector GetInitialMomentum() const = 0;
85
86 // Returns the number of trajectory points
87 virtual G4int GetPointEntries() const = 0;
88
89 // Returns i-th trajectory point
90 virtual G4VTrajectoryPoint* GetPoint(G4int i) const = 0;
91
92 // Converts attributes in trajectory (and trajectory point if
93 // needed) to ostream. A default implementation in this base class
94 // may be used or may be overridden in the concrete class. Note:
95 // the user needs to follow with new-line or end-of-string,
96 // depending on the nature of os
97 virtual void ShowTrajectory(std::ostream& os = G4cout) const;
98
99 // Draw the trajectory. A default implementation in this base
100 // class may be used or may be overridden in the concrete class
101 virtual void DrawTrajectory() const;
102
103 // If implemented by a derived class, returns a pointer to a map of
104 // attribute definitions for the attribute values below. The user
105 // must test the validity of this pointer. See G4Trajectory for an
106 // example of a concrete implementation of this method
107 virtual const std::map<G4String, G4AttDef>* GetAttDefs() const { return nullptr; }
108
109 // If implemented by a derived class, returns a pointer to a list
110 // of attribute values suitable, e.g., for picking. Each must
111 // refer to an attribute definition in the above map; its name is
112 // the key. The user must test the validity of this pointer (it
113 // must be non-zero and conform to the G4AttDefs, which may be
114 // checked with G4AttCheck) and delete the list after use. See
115 // G4Trajectory for an example of a concrete implementation of this
116 // method and G4VTrajectory::ShowTrajectory for an example of its use.
117 virtual std::vector<G4AttValue>* CreateAttValues() const { return nullptr; }
118
119 // Methods invoked exclusively by G4TrackingManager
120 virtual void AppendStep(const G4Step* aStep) = 0;
121 virtual void MergeTrajectory(G4VTrajectory* secondTrajectory) = 0;
122 };
123
124 #endif
125