| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4VTrajectory 26 // G4VTrajectory
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // This class is the abstract base class repre << 30 // This class is the abstract base class representing a trajectory of
31 // a particle being tracked. 31 // a particle being tracked.
32 // Its concrete class includes information of: 32 // Its concrete class includes information of:
33 // 1) List of trajectory points composing 33 // 1) List of trajectory points composing the trajectory;
34 // 2) Static information of the particle w 34 // 2) Static information of the particle which generated the trajectory;
35 // 3) Track ID and parent particle ID of t 35 // 3) Track ID and parent particle ID of the trajectory.
36 36
37 // Contact: 37 // Contact:
38 // Questions and comments to this code shoul 38 // Questions and comments to this code should be sent to
39 // Katsuya Amako (e-mail: Katsuya.Amako@k 39 // Katsuya Amako (e-mail: Katsuya.Amako@kek.jp)
40 // Makoto Asai (e-mail: asai@slac.stanf 40 // Makoto Asai (e-mail: asai@slac.stanford.edu)
41 // Takashi Sasaki (e-mail: Takashi.Sasaki@ 41 // Takashi Sasaki (e-mail: Takashi.Sasaki@kek.jp)
42 // ------------------------------------------- 42 // --------------------------------------------------------------------
43 #ifndef G4VTrajectory_hh 43 #ifndef G4VTrajectory_hh
44 #define G4VTrajectory_hh 1 44 #define G4VTrajectory_hh 1
45 45
46 #include "G4ThreeVector.hh" <<
47 #include "globals.hh" <<
48 <<
49 #include <map> <<
50 #include <vector> 46 #include <vector>
>> 47 #include <map>
>> 48
>> 49 #include "globals.hh"
>> 50 #include "G4ThreeVector.hh"
51 51
52 class G4Step; 52 class G4Step;
53 class G4VTrajectoryPoint; 53 class G4VTrajectoryPoint;
54 class G4AttDef; 54 class G4AttDef;
55 class G4AttValue; 55 class G4AttValue;
56 56
57 class G4VTrajectory 57 class G4VTrajectory
58 { 58 {
59 public: << 59 public:
60 // Constructor/Destrcutor << 60
61 G4VTrajectory() = default; << 61 G4VTrajectory();
62 virtual ~G4VTrajectory() = default; << 62 virtual ~G4VTrajectory();
63 << 63 // Constructor/Destrcutor
64 // Equality operator << 64
65 G4bool operator==(const G4VTrajectory& right << 65 G4bool operator == (const G4VTrajectory& right) const;
66 << 66 // Equality operator
67 // Cloning with the master thread allocator << 67
68 // Each concrete class should implement its << 68 virtual G4int GetTrackID() const = 0;
69 // This method is used only in the sub-event << 69 virtual G4int GetParentID() const = 0;
70 virtual G4VTrajectory* CloneForMaster() cons << 70 virtual G4String GetParticleName() const = 0;
71 << 71 virtual G4double GetCharge() const = 0;
72 // Accessors << 72 // Accessors
73 virtual G4int GetTrackID() const = 0; << 73
74 virtual G4int GetParentID() const = 0; << 74 virtual G4int GetPDGEncoding() const = 0;
75 virtual G4String GetParticleName() const = 0 << 75 // Charge is that of G4DynamicParticle
76 << 76 virtual G4ThreeVector GetInitialMomentum() const = 0;
77 // Charge is that of G4DynamicParticle << 77 // Zero will be returned if the particle does not have PDG code.
78 virtual G4double GetCharge() const = 0; << 78 // Momentum at the origin of the track in global coordinate system
79 << 79
80 // Zero will be returned if the particle doe << 80 virtual G4int GetPointEntries() const = 0;
81 virtual G4int GetPDGEncoding() const = 0; << 81 // Returns the number of trajectory points
82 << 82 virtual G4VTrajectoryPoint* GetPoint(G4int i) const = 0;
83 // Momentum at the origin of the track in gl << 83 // Returns i-th trajectory point
84 virtual G4ThreeVector GetInitialMomentum() c << 84 virtual void ShowTrajectory(std::ostream& os=G4cout) const;
85 << 85 // Converts attributes in trajectory (and trajectory point if
86 // Returns the number of trajectory points << 86 // needed) to ostream. A default implementation in this base class
87 virtual G4int GetPointEntries() const = 0; << 87 // may be used or may be overridden in the concrete class. Note:
88 << 88 // the user needs to follow with new-line or end-of-string,
89 // Returns i-th trajectory point << 89 // depending on the nature of os
90 virtual G4VTrajectoryPoint* GetPoint(G4int i << 90 virtual void DrawTrajectory() const;
91 << 91 // Draw the trajectory. A default implementation in this base
92 // Converts attributes in trajectory (and tr << 92 // class may be used or may be overridden in the concrete class
93 // needed) to ostream. A default implementat << 93 virtual const std::map<G4String,G4AttDef>* GetAttDefs() const
94 // may be used or may be overridden in the c << 94 { return nullptr; }
95 // the user needs to follow with new-line or << 95 // If implemented by a derived class, returns a pointer to a map of
96 // depending on the nature of os << 96 // attribute definitions for the attribute values below. The user
97 virtual void ShowTrajectory(std::ostream& os << 97 // must test the validity of this pointer. See G4Trajectory for an
98 << 98 // example of a concrete implementation of this method
99 // Draw the trajectory. A default implementa << 99 virtual std::vector<G4AttValue>* CreateAttValues() const
100 // class may be used or may be overridden in << 100 { return nullptr; }
101 virtual void DrawTrajectory() const; << 101 // If implemented by a derived class, returns a pointer to a list
102 << 102 // of attribute values suitable, e.g., for picking. Each must
103 // If implemented by a derived class, return << 103 // refer to an attribute definition in the above map; its name is
104 // attribute definitions for the attribute v << 104 // the key. The user must test the validity of this pointer (it
105 // must test the validity of this pointer. S << 105 // must be non-zero and conform to the G4AttDefs, which may be
106 // example of a concrete implementation of t << 106 // checked with G4AttCheck) and delete the list after use. See
107 virtual const std::map<G4String, G4AttDef>* << 107 // G4Trajectory for an example of a concrete implementation of this
108 << 108 // method and G4VTrajectory::ShowTrajectory for an example of its use.
109 // If implemented by a derived class, return << 109
110 // of attribute values suitable, e.g., for p << 110 virtual void AppendStep(const G4Step* aStep) = 0;
111 // refer to an attribute definition in the a << 111 virtual void MergeTrajectory(G4VTrajectory* secondTrajectory) = 0;
112 // the key. The user must test the validity << 112 // Methods invoked exclusively by G4TrackingManager
113 // must be non-zero and conform to the G4Att <<
114 // checked with G4AttCheck) and delete the l <<
115 // G4Trajectory for an example of a concrete <<
116 // method and G4VTrajectory::ShowTrajectory <<
117 virtual std::vector<G4AttValue>* CreateAttVa <<
118 <<
119 // Methods invoked exclusively by G4Tracking <<
120 virtual void AppendStep(const G4Step* aStep) <<
121 virtual void MergeTrajectory(G4VTrajectory* <<
122 }; 113 };
123 114
124 #endif 115 #endif
125 116