VTrackInformation.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MCTRUTH_VTRACKINFORMATION_H
#define MCTRUTH_VTRACKINFORMATION_H
 
#include "G4VUserTrackInformation.hh"
#include "AtlasHepMC/GenParticle_fwd.h"
 
namespace ISF {
  class ISFParticle;
}

class VTrackInformation: public G4VUserTrackInformation {
public:
  enum TrackClassification { Primary, RegeneratedPrimary, RegisteredSecondary, Secondary, BarcodeOnly } ;
  VTrackInformation(TrackClassification tc=Primary);

  TrackClassification GetClassification() const {return m_classify;}
  void SetClassification(TrackClassification tc) {m_classify=tc;}

  HepMC::ConstGenParticlePtr GetPrimaryGenParticle() const {return m_primaryGenParticle;}
  HepMC::GenParticlePtr GetPrimaryGenParticle() {return m_primaryGenParticle;}
  void  SetPrimaryGenParticle(HepMC::GenParticlePtr);

  virtual HepMC::ConstGenParticlePtr GetCurrentGenParticle() const {return nullptr;}
  virtual HepMC::GenParticlePtr GetCurrentGenParticle() {return nullptr;}
  virtual void SetCurrentGenParticle(HepMC::GenParticlePtr);

  virtual HepMC::ConstGenParticlePtr GetGenerationZeroGenParticle() const {return nullptr;}
  virtual HepMC::GenParticlePtr GetGenerationZeroGenParticle() {return nullptr;}
  virtual void SetGenerationZeroGenParticle(HepMC::GenParticlePtr);

  virtual const ISF::ISFParticle *GetBaseISFParticle() const {return nullptr;}
  virtual ISF::ISFParticle *GetBaseISFParticle() {return nullptr;}
  virtual void SetBaseISFParticle(ISF::ISFParticle*);

  virtual bool GetReturnedToISF() const;
  virtual void SetReturnedToISF(bool) ;
 
  virtual int GetParticleBarcode() const = 0;  // TODO Drop this once UniqueID and Status are used instead
  virtual int GetParticleUniqueID() const = 0;
  virtual int GetParticleStatus() const = 0;
 
  virtual void Print() const {}
private:
  TrackClassification m_classify;
  HepMC::GenParticlePtr m_primaryGenParticle{};
};
 
#endif // MCTRUTH_VTRACKINFORMATION_H