G4Trajectory.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// G4Trajectory
//
// Class description:
//
// This class represents the trajectory of a particle being tracked.
// It includes information of:
//     1) List of trajectory points which compose the trajectory;
//     2) Static information of the particle which generated the 
//        trajectory;
//     3) Track ID and parent particle ID of the trajectory.
 
// Contact:
//   Questions and comments to this code should be sent to
//     Katsuya Amako  (e-mail: [email protected])
//     Makoto  Asai   (e-mail: [email protected])
//     Takashi Sasaki (e-mail: [email protected])
// --------------------------------------------------------------------
#ifndef G4Trajectory_hh
#define G4Trajectory_hh 1
 
#include <stdlib.h>                 // Include from 'system'
#include <vector>
 
#include "trkgdefs.hh"
#include "G4VTrajectory.hh"
#include "G4Allocator.hh"
#include "G4ios.hh"                 // Include from 'system'
#include "globals.hh"               // Include from 'global'
#include "G4ParticleDefinition.hh"  // Include from 'particle+matter'
#include "G4TrajectoryPoint.hh"     // Include from 'tracking'
#include "G4Track.hh"
#include "G4Step.hh"
 
class G4Polyline;
 
class G4Trajectory : public G4VTrajectory
{
 
  using G4TrajectoryPointContainer = std::vector<G4VTrajectoryPoint*>;
 
  public:
 
    // Constructors/Destructor
 
    G4Trajectory();
    G4Trajectory(const G4Track* aTrack);
    G4Trajectory(G4Trajectory &);
    virtual ~G4Trajectory();
 
    // Operators
 
    inline void* operator new(size_t);
    inline void  operator delete(void*);
    inline G4int operator == (const G4Trajectory& r) const;
 
    // Get/Set functions 
 
    inline G4int GetTrackID() const
      { return fTrackID; }
    inline G4int GetParentID() const
      { return fParentID; }
    inline G4String GetParticleName() const
      { return ParticleName; }
    inline G4double GetCharge() const
      { return PDGCharge; }
    inline G4int GetPDGEncoding() const
      { return PDGEncoding; }
    inline G4double GetInitialKineticEnergy() const
      { return initialKineticEnergy; }
    inline G4ThreeVector GetInitialMomentum() const
      { return initialMomentum; }
 
    // Other member functions
 
    virtual void ShowTrajectory(std::ostream& os=G4cout) const;
    virtual void DrawTrajectory() const;
    virtual void AppendStep(const G4Step* aStep);
    virtual G4int GetPointEntries() const
      { return G4int(positionRecord->size()); }
    virtual G4VTrajectoryPoint* GetPoint(G4int i) const
      { return (*positionRecord)[i]; }
    virtual void MergeTrajectory(G4VTrajectory* secondTrajectory);
 
    G4ParticleDefinition* GetParticleDefinition();
 
    virtual const std::map<G4String,G4AttDef>* GetAttDefs() const;
    virtual std::vector<G4AttValue>* CreateAttValues() const;
 
  private:
 
    G4TrajectoryPointContainer* positionRecord = nullptr;
    G4int                       fTrackID = 0;
    G4int                       fParentID = 0;
    G4int                       PDGEncoding = 0;
    G4double                    PDGCharge = 0.0;
    G4String                    ParticleName = "";
    G4double                    initialKineticEnergy = 0.0;
    G4ThreeVector               initialMomentum;
};
 
extern G4TRACKING_DLL G4Allocator<G4Trajectory>*& aTrajectoryAllocator();
 
inline void* G4Trajectory::operator new(size_t)
{
  if (aTrajectoryAllocator() == nullptr)
  {
    aTrajectoryAllocator() = new G4Allocator<G4Trajectory>;
  }
  return (void*)aTrajectoryAllocator()->MallocSingle();
}
 
inline void G4Trajectory::operator delete(void* aTrajectory)
{
  aTrajectoryAllocator()->FreeSingle((G4Trajectory*)aTrajectory);
}
 
inline G4int G4Trajectory::operator == (const G4Trajectory& r) const
{
  return (this==&r);
}
 
#endif