Geant4 Cross Reference |
1 // 1 // 2 // ******************************************* 2 // ******************************************************************** 3 // * License and Disclaimer << 3 // * DISCLAIMER * 4 // * 4 // * * 5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers * 6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which * 7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: * 8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license * 9 // * include a list of copyright holders. << 10 // * 9 // * * 11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file << 14 // * use. * 16 // * for the full disclaimer and the limitatio << 17 // * 15 // * * 18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the * 19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. * 20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work * 21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this * 22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. * 23 // * acceptance of all terms of the Geant4 Sof << 24 // ******************************************* 21 // ******************************************************************** 25 // 22 // 26 // G4VTrajectory << 27 // 23 // 28 // Class description: << 24 // $Id: G4VTrajectory.hh,v 1.12 2003/06/16 17:13:15 gunter Exp $ >> 25 // GEANT4 tag $Name: geant4-05-02 $ 29 // 26 // 30 // This class is the abstract base class repre << 27 // 31 // a particle being tracked. << 28 //--------------------------------------------------------------- 32 // Its concrete class includes information of: << 29 // 33 // 1) List of trajectory points composing << 30 // G4VTrajectory.hh 34 // 2) Static information of the particle w << 31 // 35 // 3) Track ID and parent particle ID of t << 32 // class description: 36 << 33 // This class is the abstract base class which represents a trajectory of 37 // Contact: << 34 // a particle tracked. 38 // Questions and comments to this code shoul << 35 // Its concrete class includes information of 39 // Katsuya Amako (e-mail: Katsuya.Amako@k << 36 // 1) List of trajectory points which compose the trajectory, 40 // Makoto Asai (e-mail: asai@slac.stanf << 37 // 2) static information of particle which generated the 41 // Takashi Sasaki (e-mail: Takashi.Sasaki@ << 38 // trajectory, 42 // ------------------------------------------- << 39 // 3) trackID and parent particle ID of the trajectory, 43 #ifndef G4VTrajectory_hh << 40 // 44 #define G4VTrajectory_hh 1 << 41 // --------------------------------------------------------------- 45 42 46 #include "G4ThreeVector.hh" << 43 #ifndef G4VTrajectory_h 47 #include "globals.hh" << 44 #define G4VTrajectory_h 1 48 45 49 #include <map> << 46 #include "globals.hh" 50 #include <vector> 47 #include <vector> >> 48 #include <map> >> 49 #include "G4ThreeVector.hh" 51 50 52 class G4Step; 51 class G4Step; 53 class G4VTrajectoryPoint; 52 class G4VTrajectoryPoint; 54 class G4AttDef; 53 class G4AttDef; 55 class G4AttValue; 54 class G4AttValue; 56 55 57 class G4VTrajectory 56 class G4VTrajectory 58 { 57 { >> 58 public: // with description >> 59 >> 60 // Constructor/Destrcutor >> 61 >> 62 G4VTrajectory() {;} >> 63 virtual ~G4VTrajectory() {;} >> 64 >> 65 // Operators >> 66 inline int operator == (const G4VTrajectory& right) const >> 67 {return (this==&right);} >> 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(G4int i_mode=0) 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. >> 99 virtual std::vector<G4AttValue>* CreateAttValues() const >> 100 { return 0; } >> 101 // If implemented by a derived class, returns a pointer to a list >> 102 // of attribute values suitable, e.g., for picking. Each must >> 103 // refer to an attribute definition in the above map; its name is >> 104 // the key. The user must test the validity of this pointer and >> 105 // delete the list after use. >> 106 59 public: 107 public: 60 // Constructor/Destrcutor << 108 // Following methods MUST be invoked exclusively by G4TrackingManager 61 G4VTrajectory() = default; << 109 virtual void AppendStep(const G4Step* aStep) = 0; 62 virtual ~G4VTrajectory() = default; << 110 virtual void MergeTrajectory(G4VTrajectory* secondTrajectory) = 0; 63 << 111 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 }; 112 }; 123 113 124 #endif 114 #endif >> 115 >> 116 >> 117 >> 118 >> 119 >> 120 >> 121 >> 122 >> 123 >> 124 125 125