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