Geant4  10.00.p01
G4VTrajectory.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: G4VTrajectory.hh 66241 2012-12-13 18:34:42Z gunter $
28 //
29 //---------------------------------------------------------------
30 //
31 // G4VTrajectory.hh
32 //
33 // class description:
34 // This class is the abstract base class which represents a trajectory of
35 // a particle tracked.
36 // Its concrete class includes information of
37 // 1) List of trajectory points which compose the trajectory,
38 // 2) static information of particle which generated the
39 // trajectory,
40 // 3) trackID and parent particle ID of the trajectory,
41 //
42 // ---------------------------------------------------------------
43 
44 #ifndef G4VTrajectory_h
45 #define G4VTrajectory_h 1
46 
47 #include "globals.hh"
48 #include <vector>
49 #include <map>
50 #include "G4ThreeVector.hh"
51 
52 class G4Step;
53 class G4VTrajectoryPoint;
54 class G4AttDef;
55 class G4AttValue;
56 
58 {
59  public: // with description
60 
61 // Constructor/Destrcutor
62 
63  G4VTrajectory();
64  virtual ~G4VTrajectory();
65 
66 // Operators
67  G4bool operator == (const G4VTrajectory& right) const;
68 
69 // Get/Set functions
70  virtual G4int GetTrackID() const = 0;
71  virtual G4int GetParentID() const = 0;
72  virtual G4String GetParticleName() const = 0;
73  virtual G4double GetCharge() const = 0;
74  // Charge is that of G4DynamicParticle
75  virtual G4int GetPDGEncoding() const = 0;
76  // Zero will be returned if the particle does not have PDG code.
77  virtual G4ThreeVector GetInitialMomentum() const = 0;
78  // Momentum at the origin of the track in global coordinate system.
79 
80 // Other member functions
81  virtual int GetPointEntries() const = 0;
82  // Returns the number of trajectory points
83  virtual G4VTrajectoryPoint* GetPoint(G4int i) const = 0;
84  // Returns i-th trajectory point.
85  virtual void ShowTrajectory(std::ostream& os=G4cout) const;
86  // Convert attributes in trajectory (and trajectory point if
87  // needed) to ostream. A default implementation in this base class
88  // may be used or may be overridden in the concrete class. Note:
89  // the user needs to follow with new-line or end-of-string,
90  // depending on the nature of os.
91  virtual void DrawTrajectory() const;
92  // Draw the trajectory. A default implementation in this base
93  // class may be used or may be overridden in the concrete class.
94  virtual const std::map<G4String,G4AttDef>* GetAttDefs() const
95  { return 0; }
96  // If implemented by a derived class, returns a pointer to a map of
97  // attribute definitions for the attribute values below. The user
98  // must test the validity of this pointer. See G4Trajectory for an
99  // example of a concrete implementation of this method.
100  virtual std::vector<G4AttValue>* CreateAttValues() const
101  { return 0; }
102  // If implemented by a derived class, returns a pointer to a list
103  // of attribute values suitable, e.g., for picking. Each must
104  // refer to an attribute definition in the above map; its name is
105  // the key. The user must test the validity of this pointer (it
106  // must be non-zero and conform to the G4AttDefs, which may be
107  // checked with G4AttCheck) and delete the list after use. See
108  // G4Trajectory for an example of a concrete implementation of this
109  // method and G4VTrajectory::ShowTrajectory for an example of its
110  // use.
111 
112  public:
113  // Following methods MUST be invoked exclusively by G4TrackingManager
114  virtual void AppendStep(const G4Step* aStep) = 0;
115  virtual void MergeTrajectory(G4VTrajectory* secondTrajectory) = 0;
116 
117 };
118 
119 #endif
120 
121 
122 
123 
124 
125 
126 
127 
128 
129 
CLHEP::Hep3Vector G4ThreeVector
virtual G4VTrajectoryPoint * GetPoint(G4int i) const =0
int G4int
Definition: G4Types.hh:78
virtual void DrawTrajectory() const
virtual void MergeTrajectory(G4VTrajectory *secondTrajectory)=0
virtual int GetPointEntries() const =0
G4GLOB_DLL std::ostream G4cout
virtual G4String GetParticleName() const =0
virtual const std::map< G4String, G4AttDef > * GetAttDefs() const
bool G4bool
Definition: G4Types.hh:79
virtual G4int GetParentID() const =0
virtual G4int GetPDGEncoding() const =0
Definition: G4Step.hh:76
virtual G4double GetCharge() const =0
virtual ~G4VTrajectory()
virtual void AppendStep(const G4Step *aStep)=0
virtual std::vector< G4AttValue > * CreateAttValues() const
G4bool operator==(const G4VTrajectory &right) const
virtual G4int GetTrackID() const =0
virtual G4ThreeVector GetInitialMomentum() const =0
double G4double
Definition: G4Types.hh:76
virtual void ShowTrajectory(std::ostream &os=G4cout) const