VTrackInformation Class Reference

Instances of classes derived from this class are attached as UserInformation to G4Tracks. It extends G4VUserTrackInformation. The GenParticlePtr held by the VTrackInformation object can change during simulation (i.e. each time the track undergoes a non-destructive interaction). The member variables are m_classify: a classification of the current G4Track (Primary, Regenerated Primary, Registered Secondary, Secondary) and m_primaryGenParticle: a pointer to the GenParticle used to create the initial G4PrimaryParticle from which the current G4Track decends. More...

#include <VTrackInformation.h>

Inheritance diagram for VTrackInformation:

Collaboration diagram for VTrackInformation:

Public Types
enum	TrackClassification {   Primary, RegeneratedPrimary, RegisteredSecondary, Secondary,   BarcodeOnly }

Public Member Functions
	VTrackInformation (TrackClassification tc=Primary)
TrackClassification	GetClassification () const
	return the classification of the current G4Ttrack (Primary, Regenerated Primary, Registered Secondary, Secondary) More...
void	SetClassification (TrackClassification tc)
	update the classification of the currently tracked particle, usually called when a new G4Track is created or after it survives an interaction. More...
HepMC::ConstGenParticlePtr	GetPrimaryGenParticle () const
	return a pointer to the GenParticle used to create the initial G4PrimaryParticle from which the current G4Track decends. More...
HepMC::GenParticlePtr	GetPrimaryGenParticle ()
void	SetPrimaryGenParticle (HepMC::GenParticlePtr)
	set the pointer to the GenParticle used to create the initial G4PrimaryParticle from which the current G4Track decends. More...
virtual HepMC::ConstGenParticlePtr	GetCurrentGenParticle () const
	return a pointer to the GenParticle corresponding to the current G4Track (if there is one). More...
virtual HepMC::GenParticlePtr	GetCurrentGenParticle ()
virtual void	SetCurrentGenParticle (HepMC::GenParticlePtr)
	set the pointer to the GenParticle corresponding to the current G4Track. More...
virtual const ISF::ISFParticle *	GetBaseISFParticle () const
	return a pointer to the ISFParticle corresponding to the current G4Track. More...
virtual ISF::ISFParticle *	GetBaseISFParticle ()
virtual void	SetBaseISFParticle (ISF::ISFParticle *)
	set the pointer to the ISFParticle corresponding to the current G4Track. More...
virtual bool	GetReturnedToISF () const
	Is the ISFParticle corresponding to the current G4Track scheduled to be returned to the ISF? More...
virtual void	SetReturnedToISF (bool)
	Flag whether the ISFParticle corresponding to the current G4Track scheduled to be returned to the ISF. More...
virtual int	GetParticleBarcode () const =0
virtual int	GetParticleUniqueID () const =0
virtual int	GetParticleStatus () const =0
virtual void	Print () const

Private Attributes
TrackClassification	m_classify
HepMC::GenParticlePtr	m_primaryGenParticle {}

Detailed Description

Instances of classes derived from this class are attached as UserInformation to G4Tracks. It extends G4VUserTrackInformation. The GenParticlePtr held by the VTrackInformation object can change during simulation (i.e. each time the track undergoes a non-destructive interaction). The member variables are m_classify: a classification of the current G4Track (Primary, Regenerated Primary, Registered Secondary, Secondary) and m_primaryGenParticle: a pointer to the GenParticle used to create the initial G4PrimaryParticle from which the current G4Track decends.

Dervived classes also provide access to the GenParticle corresponding to the current G4Track (if one exists)

Definition at line 30 of file VTrackInformation.h.

Member Enumeration Documentation

TrackClassification

enum VTrackInformation::TrackClassification

Enumerator
Primary
RegeneratedPrimary
RegisteredSecondary
Secondary
BarcodeOnly

Definition at line 32 of file VTrackInformation.h.

{ Primary, RegeneratedPrimary, RegisteredSecondary, Secondary, BarcodeOnly } ;

Constructor & Destructor Documentation

VTrackInformation()

VTrackInformation::VTrackInformation

(

TrackClassification

tc = Primary

)

Definition at line 7 of file VTrackInformation.cxx.

  : m_classify(tc)
{
}

Member Function Documentation

GetBaseISFParticle() [1/2]

virtual ISF::ISFParticle* VTrackInformation::GetBaseISFParticle ( )

inlinevirtual

Reimplemented in TrackInformation, and TrackBarcodeInfo.

Definition at line 81 of file VTrackInformation.h.

{return nullptr;}

GetBaseISFParticle() [2/2]

virtual const ISF::ISFParticle* VTrackInformation::GetBaseISFParticle ( ) const

inlinevirtual

return a pointer to the ISFParticle corresponding to the current G4Track.

Reimplemented in TrackInformation, and TrackBarcodeInfo.

Definition at line 80 of file VTrackInformation.h.

{return nullptr;}

GetClassification()

TrackClassification VTrackInformation::GetClassification ( ) const

inline

return the classification of the current G4Ttrack (Primary, Regenerated Primary, Registered Secondary, Secondary)

Definition at line 39 of file VTrackInformation.h.

{return m_classify;}

GetCurrentGenParticle() [1/2]

virtual HepMC::GenParticlePtr VTrackInformation::GetCurrentGenParticle ( )

inlinevirtual

Reimplemented in TrackInformation.

Definition at line 68 of file VTrackInformation.h.

{return nullptr;}

GetCurrentGenParticle() [2/2]

virtual HepMC::ConstGenParticlePtr VTrackInformation::GetCurrentGenParticle ( ) const

inlinevirtual

return a pointer to the GenParticle corresponding to the current G4Track (if there is one).

Reimplemented in TrackInformation.

Definition at line 67 of file VTrackInformation.h.

{return nullptr;}

GetParticleBarcode()

virtual int VTrackInformation::GetParticleBarcode ( ) const

pure virtual

Implemented in TrackInformation, and TrackBarcodeInfo.

GetParticleStatus()

virtual int VTrackInformation::GetParticleStatus ( ) const

pure virtual

Implemented in TrackInformation, and TrackBarcodeInfo.

GetParticleUniqueID()

virtual int VTrackInformation::GetParticleUniqueID ( ) const

pure virtual

Implemented in TrackInformation, and TrackBarcodeInfo.

GetPrimaryGenParticle() [1/2]

HepMC::GenParticlePtr VTrackInformation::GetPrimaryGenParticle ( )

inline

Definition at line 55 of file VTrackInformation.h.

{return m_primaryGenParticle;}

GetPrimaryGenParticle() [2/2]

HepMC::ConstGenParticlePtr VTrackInformation::GetPrimaryGenParticle ( ) const

inline

return a pointer to the GenParticle used to create the initial G4PrimaryParticle from which the current G4Track decends.

Should match the return value of ISF::TruthBinding::getPrimaryGenParticle(). TODO Check that this is required.

Definition at line 54 of file VTrackInformation.h.

{return m_primaryGenParticle;}

GetReturnedToISF()

bool VTrackInformation::GetReturnedToISF ( ) const

virtual

Is the ISFParticle corresponding to the current G4Track scheduled to be returned to the ISF?

Reimplemented in TrackInformation, and TrackBarcodeInfo.

Definition at line 17 of file VTrackInformation.cxx.

{
  return false;
}

Print()

virtual void VTrackInformation::Print ( ) const

inlinevirtual

Definition at line 105 of file VTrackInformation.h.

{}

SetBaseISFParticle()

void VTrackInformation::SetBaseISFParticle ( ISF::ISFParticle *  )

virtual

set the pointer to the ISFParticle corresponding to the current G4Track.

(Only used to replace the ISFParticle by a copy of itself when the G4Track is killed and the copy is scheduled to be returned to the ISF.)

Reimplemented in TrackInformation, and TrackBarcodeInfo.

Definition at line 28 of file VTrackInformation.cxx.

{
  // you should not call this, perhaps throw an exception?
  std::cerr<<"ERROR  VTrackInformation::SetBaseISFParticle() not supported  "<<std::endl;
}

SetClassification()

void VTrackInformation::SetClassification ( TrackClassification  tc )

inline

update the classification of the currently tracked particle, usually called when a new G4Track is created or after it survives an interaction.

Definition at line 45 of file VTrackInformation.h.

{m_classify=tc;}

SetCurrentGenParticle()

void VTrackInformation::SetCurrentGenParticle ( HepMC::GenParticlePtr  )

virtual

set the pointer to the GenParticle corresponding to the current G4Track.

This will be updated each time an interaction of the G4Track is recorded to the HepMC::GenEvent.

Reimplemented in TrackInformation.

Definition at line 22 of file VTrackInformation.cxx.

{
  // you should not call this, perhaps throw an exception?
  std::cerr<<"ERROR  VTrackInformation::SetCurrentGenParticle() not supported  "<<std::endl;
}

SetPrimaryGenParticle()

void VTrackInformation::SetPrimaryGenParticle

(

HepMC::GenParticlePtr

p

)

set the pointer to the GenParticle used to create the initial G4PrimaryParticle from which the current G4Track decends.

TODO Check that this is required - if so, ensure it is set consistently.

Definition at line 12 of file VTrackInformation.cxx.

{
  m_primaryGenParticle = std::move(p);
}

SetReturnedToISF()

void VTrackInformation::SetReturnedToISF ( bool  )

virtual

Flag whether the ISFParticle corresponding to the current G4Track scheduled to be returned to the ISF.

Only called in TrackProcessorUserActionPassBack::returnParticleToISF

Reimplemented in TrackInformation, and TrackBarcodeInfo.

Definition at line 34 of file VTrackInformation.cxx.

{
  std::cerr<<"ERROR  VTrackInformation::SetReturnedToISF() not supported  "<<std::endl;
}

Member Data Documentation

m_classify

TrackClassification VTrackInformation::m_classify

private

Definition at line 107 of file VTrackInformation.h.

m_primaryGenParticle

HepMC::GenParticlePtr VTrackInformation::m_primaryGenParticle {}

private

Definition at line 108 of file VTrackInformation.h.

---

The documentation for this class was generated from the following files:

• VTrackInformation.h
• VTrackInformation.cxx