RE04/include/RE04Trajectory.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 /// \file RE04Trajectory.hh
0027 /// \brief Definition of the RE04Trajectory class
0028
0029 #ifndef RE04Trajectory_h
0030 #define RE04Trajectory_h 1
0031
0032 #include "RE04TrajectoryPoint.hh"  // Include from 'tracking'
0033
0034 #include "G4Allocator.hh"
0035 #include "G4ParticleDefinition.hh"  // Include from 'particle+matter'
0036 #include "G4Step.hh"
0037 #include "G4Track.hh"
0038 #include "G4VTrajectory.hh"
0039 #include "G4ios.hh"  // Include from 'system'
0040 #include "globals.hh"  // Include from 'global'
0041
0042 #include <stdlib.h>  // Include from 'system'
0043 #include <vector>  // G4RWTValOrderedVector
0044
0045 class G4Polyline;  // Forward declaration.
0046
0047 typedef std::vector<G4VTrajectoryPoint*> TrajectoryPointContainer;
0048
0049 //
0050 /// User trajectory class
0051 ///
0052 /// - new, delete and "==" operators are overwritten
0053 ///
0054 /// - get functions
0055 ///     G4int GetTrackID() const, G4int GetParentID() const,
0056 ///     G4String GetParticleName() const, G4double GetCharge() const,
0057 ///     G4int GetPDGEncoding() const, G4double GetInitialKineticEnergy() const
0058 ///     and G4ThreeVector GetInitialMomentum() const
0059 ///
0060 /// - void ShowTrajectory(std::ostream& os=G4cout) const
0061 ///     invokes the default implementation
0062 ///
0063 /// - void DrawTrajectory() const
0064 ///     invokes the default implementation
0065 ///
0066 /// - void AppendStep(const G4Step* aStep)
0067 ///     adds a user trajectory point object, RE04TrajectoryPoint
0068 ///
0069 /// - int GetPointEntries() const
0070 ///     returns the number of point entries
0071 ///
0072 /// - G4VTrajectoryPoint* GetPoint(G4int i) const
0073 ///     gets the i-th trajectory point
0074 ///
0075 /// - void MergeTrajectory(G4VTrajectory* secondTrajectory)
0076 ///     adds a trajectory to a TrajectoryPointContainer, fPositionRecord
0077 ///
0078 /// - G4ParticleDefinition* GetParticleDefinition()
0079 ///     get a particle definition from G4ParticleTable
0080 ///
0081 /// - const std::map<G4String,G4AttDef>* GetAttDefs() const
0082 ///    defines the track ID, the parent ID, the particle name, the charge,
0083 ///    the PDG encoding, the initial kinetic energy, the initial momentum,
0084 ///    the initial momentum magnitude and the number of points as attiributes
0085 ///
0086 /// - std::vector<G4AttValue>* CreateAttValues() const
0087 ///    sets and returns the attributes
0088 //
0089 ///////////////////
0090 class RE04Trajectory : public G4VTrajectory
0091 ///////////////////
0092 {
0093     //--------
0094   public:
0095     //--------
0096
0097     // Constructor/Destrcutor
0098
0099     RE04Trajectory();
0100
0101     RE04Trajectory(const G4Track* aTrack);
0102     RE04Trajectory(RE04Trajectory&);
0103     virtual ~RE04Trajectory();
0104
0105     // Operators
0106     inline void* operator new(size_t);
0107     inline void operator delete(void*);
0108     inline int operator==(const RE04Trajectory& right) const { return (this == &right); }
0109
0110     // Get/Set functions
0111     inline virtual G4int GetTrackID() const { return fTrackID; }
0112     inline virtual G4int GetParentID() const { return fParentID; }
0113     inline virtual G4String GetParticleName() const { return fParticleName; }
0114     inline virtual G4double GetCharge() const { return fPDGCharge; }
0115     inline virtual G4int GetPDGEncoding() const { return fPDGEncoding; }
0116     inline virtual G4double GetInitialKineticEnergy() const { return fInitialKineticEnergy; }
0117     inline virtual G4ThreeVector GetInitialMomentum() const { return fInitialMomentum; }
0118
0119     // Other member functions
0120     virtual void ShowTrajectory(std::ostream& os = G4cout) const;
0121     // virtual void DrawTrajectory() const;
0122     virtual void DrawTrajectory() const;
0123     virtual void AppendStep(const G4Step* aStep);
0124     virtual int GetPointEntries() const { return fPositionRecord->size(); }
0125     virtual G4VTrajectoryPoint* GetPoint(G4int i) const { return (*fPositionRecord)[i]; }
0126     virtual void MergeTrajectory(G4VTrajectory* secondTrajectory);
0127
0128     G4ParticleDefinition* GetParticleDefinition();
0129
0130     virtual const std::map<G4String, G4AttDef>* GetAttDefs() const;
0131     virtual std::vector<G4AttValue>* CreateAttValues() const;
0132
0133     //---------
0134   private:
0135     //---------
0136
0137     TrajectoryPointContainer* fPositionRecord;
0138     G4int fTrackID;
0139     G4int fParentID;
0140     G4int fPDGEncoding;
0141     G4double fPDGCharge;
0142     G4String fParticleName;
0143     G4double fInitialKineticEnergy;
0144     G4ThreeVector fInitialMomentum;
0145 };
0146
0147 extern G4ThreadLocal G4Allocator<RE04Trajectory>* faTrajAllocator;
0148
0149 inline void* RE04Trajectory::operator new(size_t)
0150 {
0151   if (!faTrajAllocator) faTrajAllocator = new G4Allocator<RE04Trajectory>;
0152   return (void*)faTrajAllocator->MallocSingle();
0153 }
0154
0155 inline void RE04Trajectory::operator delete(void* aTrajectory)
0156 {
0157   faTrajAllocator->FreeSingle((RE04Trajectory*)aTrajectory);
0158 }
0159
0160 #endif