HepMC3 event record library
Public Member Functions | Data Fields | Private Attributes
HepMC3Particle Class Reference

HEPParticle interface to HepMC classes. More...

#include <HepMC3Particle.h>

+ Inheritance diagram for HepMC3Particle:
+ Collaboration diagram for HepMC3Particle:

Public Member Functions

 HepMC3Particle ()
 
 HepMC3Particle (HepMC3::GenParticle &particle, HEPEvent *e, int Id)
 
 ~HepMC3Particle ()
 
const HepMC3Particle operator= (HEPParticle &p)
 
HEPEvent * GetEvent ()
 
int const GetId ()
 
int const GetMother ()
 
int const GetMother2 ()
 
int const GetFirstDaughter ()
 
int const GetLastDaughter ()
 
double const GetE ()
 
double const GetPx ()
 
double const GetPy ()
 
double const GetPz ()
 
double const GetM ()
 
int const GetPDGId ()
 
int const GetStatus ()
 
int const IsStable ()
 
int const Decays ()
 
int const IsHistoryEntry ()
 
double const GetVx ()
 
double const GetVy ()
 
double const GetVz ()
 
double const GetTau ()
 
void SetEvent (HEPEvent *event)
 
void SetId (int id)
 
void SetMother (int mother)
 
void SetMother2 (int mother)
 
void SetFirstDaughter (int daughter)
 
void SetLastDaughter (int daughter)
 
void SetE (double E)
 
void SetPx (double px)
 
void SetPy (double py)
 
void SetPz (double pz)
 
void SetM (double m)
 
void SetPDGId (int pdg)
 
void SetStatus (int st)
 
void SetVx (double vx)
 
void SetVy (double vy)
 
void SetVz (double vz)
 
void SetTau (double tau)
 
HEPParticleList * GetDaughterList (HEPParticleList *list)
 
HEPParticleList * GetMotherList (HEPParticleList *list)
 

Data Fields

HepMC3::GenParticlepart
 

Private Attributes

HepMC3Eventevent
 
int id
 

Detailed Description

HEPParticle interface to HepMC classes.

HepMC3Particle extends GenParticle class, so that MC-TESTER can accesses the particle information through the common HEPEvent methods

Definition at line 25 of file HepMC3Particle.h.

Constructor & Destructor Documentation

Plain constructor.

HepMC3Particle ( HepMC3::GenParticle particle,
HEPEvent *  e,
int  Id 
)

Constructor which makes a HepMC3Particle from GenParticle.

Destructor

Member Function Documentation

int const Decays ( )

Returns true is the particle has status code 2 or (for pythia 8) if it has a status < 0, has an end vertex and does not have any daughters of the same PDG code.

HEPParticleList* GetDaughterList ( HEPParticleList *  list)

Returns a list of daughter particles of this particle. If a list of particle is given as a parameter, the daughters are appended to the end. If the daughter is already found in the list, it is not added. The function finds daughters by iterating over the outgoing particles from the end vertex. The daughter particle must be stable of decaying to be added to the list. (for pythia 8) if the status code is negative, the daughter's daughters are searched recursively.

double const GetE ( )

Returns the particle's energy

HEPEvent* GetEvent ( )

Returns the event that this particle belongs to.

int const GetFirstDaughter ( )

Dummy function definition. Do not use.

int const GetId ( )

returns the ID number of particle as used by MC-TESTER (not the same as GenParticle pdg_id or barcode).

int const GetLastDaughter ( )

Dummy function definition. Do not use.

double const GetM ( )

Returns the particle's mass

int const GetMother ( )

Dummy function definition. Do not use.

int const GetMother2 ( )

Dummy function definition. Do not use.

HEPParticleList* GetMotherList ( HEPParticleList *  list)

Returns a list of daughter particles of this particle.

int const GetPDGId ( )

Returns the particle's PDG ID code.

double const GetPx ( )

Returns the x component of the particle's momentum

double const GetPy ( )

Returns the y component of the particle's momentum

double const GetPz ( )

Returns the z component of the particle's momentum

int const GetStatus ( )

Returns the particle's Status code.

double const GetTau ( )

Dummy function definition. Do not use.

double const GetVx ( )

Returns the x value of the particle's production vertex

double const GetVy ( )

Returns the y value of the particle's production vertex

double const GetVz ( )

Returns the z value of the particle's production vertex

int const IsHistoryEntry ( )

Returns true is the particle has status code 3 or (for pythia 8) if fails both IsStable() and Decays().

int const IsStable ( )

Returns true is the particle has status code 1.

const HepMC3Particle operator= ( HEPParticle &  p)

Set all the particle properties of "p" to this particle.

void SetE ( double  E)

Sets the energy of this particle

void SetEvent ( HEPEvent *  event)

Sets the event that this particle belongs to

void SetFirstDaughter ( int  daughter)

Dummy function definition. Do not use.

void SetId ( int  id)

Sets ID (as used by MC-TESTER) of this particle

void SetLastDaughter ( int  daughter)

Dummy function definition. Do not use.

void SetM ( double  m)

Dummy function definition. Do not use.

void SetMother ( int  mother)

Dummy function definition. Do not use.

void SetMother2 ( int  mother)

Dummy function definition. Do not use.

void SetPDGId ( int  pdg)

Sets the PDG ID code of this particle

void SetPx ( double  px)

Sets the x component of this particle's momentum

void SetPy ( double  py)

Sets the x component of this particle's momentum

void SetPz ( double  pz)

Sets the x component of this particle's momentum

void SetStatus ( int  st)

Sets the status code of this particle

void SetTau ( double  tau)

Dummy function definition. Do not use.

void SetVx ( double  vx)

Sets the x value of this particle's production vertex

void SetVy ( double  vy)

Sets the y value of this particle's production vertex

void SetVz ( double  vz)

Sets the z value of this particle's production vertex

Field Documentation

HepMC3Event* event
private

Event which the particle belongs to.

Definition at line 30 of file HepMC3Particle.h.

int id
private

ID number of particle as given by MC-TESTER (not the same as GenParticle pdg_id or barcode).

Definition at line 33 of file HepMC3Particle.h.


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