simcore::UserPrimaryParticleInformation Class Reference

Defines extra information attached to a Geant4 primary particle. More...

#include <UserPrimaryParticleInformation.h>

Public Member Functions
	UserPrimaryParticleInformation ()=default
	Class Constructor.
virtual	~UserPrimaryParticleInformation ()=default
	Class destructor.
void	setHepEvtStatus (int hepEvtStatus)
	Set the HEP event status (generator status) e.g.
int	getHepEvtStatus ()
	Get the HEP event status.
void	Print () const
	Implement virtual method (no-op).

Private Attributes
int	hepEvtStatus_ {-1}
	The HEP event status.

Detailed Description

Defines extra information attached to a Geant4 primary particle.

Definition at line 19 of file UserPrimaryParticleInformation.h.

Member Function Documentation

getHepEvtStatus()

int simcore::UserPrimaryParticleInformation::getHepEvtStatus ( )

inline

Get the HEP event status.

Returns

The HEP event status.

Definition at line 42 of file UserPrimaryParticleInformation.h.

{ return hepEvtStatus_; }

References hepEvtStatus_.

Referenced by simcore::g4user::PrimaryGeneratorAction::GeneratePrimaries(), and simcore::g4user::TrackingAction::PreUserTrackingAction().

Print()

void simcore::UserPrimaryParticleInformation::Print ( ) const

inline

Implement virtual method (no-op).

Definition at line 47 of file UserPrimaryParticleInformation.h.

{}

setHepEvtStatus()

void simcore::UserPrimaryParticleInformation::setHepEvtStatus ( int  hepEvtStatus )

inline

Set the HEP event status (generator status) e.g.

from an LHE particle.

Parameters

hepEvtStatus

The HEP event status.

Definition at line 36 of file UserPrimaryParticleInformation.h.

{ hepEvtStatus_ = hepEvtStatus; }

References hepEvtStatus_.

Referenced by simcore::generators::LHEPrimaryGenerator::GeneratePrimaryVertex(), and simcore::generators::MultiParticleGunPrimaryGenerator::GeneratePrimaryVertex().

Member Data Documentation

hepEvtStatus_

int simcore::UserPrimaryParticleInformation::hepEvtStatus_ {-1}

private

The HEP event status.

Definition at line 53 of file UserPrimaryParticleInformation.h.

{-1};

Referenced by getHepEvtStatus(), and setHepEvtStatus().

---

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

• SimCore/include/SimCore/UserPrimaryParticleInformation.h