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 << 27 // 26 // 28 // Class description: << 27 // $Id: G4VTrajectory.hh,v 1.17 2006/06/29 21:15:51 gunter Exp $ >> 28 // GEANT4 tag $Name: geant4-09-02-patch-04 $ 29 // 29 // 30 // This class is the abstract base class repre << 30 //--------------------------------------------------------------- 31 // a particle being tracked. << 31 // 32 // Its concrete class includes information of: << 32 // G4VTrajectory.hh 33 // 1) List of trajectory points composing << 33 // 34 // 2) Static information of the particle w << 34 // class description: 35 // 3) Track ID and parent particle ID of t << 35 // This class is the abstract base class which represents a trajectory of 36 << 36 // a particle tracked. 37 // Contact: << 37 // Its concrete class includes information of 38 // Questions and comments to this code shoul << 38 // 1) List of trajectory points which compose the trajectory, 39 // Katsuya Amako (e-mail: Katsuya.Amako@k << 39 // 2) static information of particle which generated the 40 // Makoto Asai (e-mail: asai@slac.stanf << 40 // trajectory, 41 // Takashi Sasaki (e-mail: Takashi.Sasaki@ << 41 // 3) trackID and parent particle ID of the trajectory, 42 // ------------------------------------------- << 42 // 43 #ifndef G4VTrajectory_hh << 43 // --------------------------------------------------------------- 44 #define G4VTrajectory_hh 1 << 45 44 46 #include "G4ThreeVector.hh" << 45 #ifndef G4VTrajectory_h 47 #include "globals.hh" << 46 #define G4VTrajectory_h 1 48 47 49 #include <map> << 48 #include "globals.hh" 50 #include <vector> 49 #include <vector> >> 50 #include <map> >> 51 #include "G4ThreeVector.hh" 51 52 52 class G4Step; 53 class G4Step; 53 class G4VTrajectoryPoint; 54 class G4VTrajectoryPoint; 54 class G4AttDef; 55 class G4AttDef; 55 class G4AttValue; 56 class G4AttValue; 56 57 57 class G4VTrajectory 58 class G4VTrajectory 58 { 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. >> 92 virtual void DrawTrajectory(G4int i_mode=0) const; >> 93 // Draw the trajectory. A default implementation in this base >> 94 // class may be used or may be overridden in the concrete class. >> 95 virtual const std::map<G4String,G4AttDef>* GetAttDefs() const >> 96 { return 0; } >> 97 // If implemented by a derived class, returns a pointer to a map of >> 98 // attribute definitions for the attribute values below. The user >> 99 // must test the validity of this pointer. See G4Trajectory for an >> 100 // example of a concrete implementation of this method. >> 101 virtual std::vector<G4AttValue>* CreateAttValues() const >> 102 { return 0; } >> 103 // If implemented by a derived class, returns a pointer to a list >> 104 // of attribute values suitable, e.g., for picking. Each must >> 105 // refer to an attribute definition in the above map; its name is >> 106 // the key. The user must test the validity of this pointer (it >> 107 // must be non-zero and conform to the G4AttDefs, which may be >> 108 // checked with G4AttCheck) and delete the list after use. See >> 109 // G4Trajectory for an example of a concrete implementation of this >> 110 // method and G4VTrajectory::ShowTrajectory for an example of its >> 111 // use. >> 112 59 public: 113 public: 60 // Constructor/Destrcutor << 114 // Following methods MUST be invoked exclusively by G4TrackingManager 61 G4VTrajectory() = default; << 115 virtual void AppendStep(const G4Step* aStep) = 0; 62 virtual ~G4VTrajectory() = default; << 116 virtual void MergeTrajectory(G4VTrajectory* secondTrajectory) = 0; 63 << 117 64 // Equality operator << 65 G4bool operator==(const G4VTrajectory& right << 66 << 67 // Cloning with the master thread allocator << 68 // Each concrete class should implement its << 69 // This method is used only in the sub-event << 70 virtual G4VTrajectory* CloneForMaster() cons << 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 doe << 81 virtual G4int GetPDGEncoding() const = 0; << 82 << 83 // Momentum at the origin of the track in gl << 84 virtual G4ThreeVector GetInitialMomentum() c << 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 << 91 << 92 // Converts attributes in trajectory (and tr << 93 // needed) to ostream. A default implementat << 94 // may be used or may be overridden in the c << 95 // the user needs to follow with new-line or << 96 // depending on the nature of os << 97 virtual void ShowTrajectory(std::ostream& os << 98 << 99 // Draw the trajectory. A default implementa << 100 // class may be used or may be overridden in << 101 virtual void DrawTrajectory() const; << 102 << 103 // If implemented by a derived class, return << 104 // attribute definitions for the attribute v << 105 // must test the validity of this pointer. S << 106 // example of a concrete implementation of t << 107 virtual const std::map<G4String, G4AttDef>* << 108 << 109 // If implemented by a derived class, return << 110 // of attribute values suitable, e.g., for p << 111 // refer to an attribute definition in the a << 112 // the key. The user must test the validity << 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 }; 118 }; 123 119 124 #endif 120 #endif >> 121 >> 122 >> 123 >> 124 >> 125 >> 126 >> 127 >> 128 >> 129 >> 130 125 131