GGSTMCTruthInfo Class Reference

A class to store MC truth informations on ROOT files. More...

#include <GGSTMCTruthInfo.h>

Inheritance diagram for GGSTMCTruthInfo:

Collaboration diagram for GGSTMCTruthInfo:

Public Member Functions
	GGSTMCTruthInfo ()
	Constructor.
	~GGSTMCTruthInfo ()
	Destructor.
UInt_t	GetNPrimaries ()
	Retrieves the number of primaries in this event. More...
GGSTParticle *	GetPrimaryParticle (UInt_t particleNumber)
	Retrieves a primary particle. More...
void	AddPrimaryParticle (GGSTParticle *primaryParticle)
	Adds a primary particle to the particles' array. More...
void	Reset ()
	Resets the object's properties.

Data Fields
Int_t	eventID
	The event ID.
UInt_t	nDiscarded
	The number of discarded + killed events the current event and the previous event saved in file. More...

Detailed Description

A class to store MC truth informations on ROOT files.

Definition at line 20 of file GGSTMCTruthInfo.h.

Member Function Documentation

void GGSTMCTruthInfo::AddPrimaryParticle

(

GGSTParticle *

primaryParticle

)

Adds a primary particle to the particles' array.

Parameters

primaryParticle

The particle to add.

Definition at line 48 of file GGSTMCTruthInfo.cpp.

                                                                      {

  Int_t n = _primaries->GetEntries();
  new ((*_primaries)[n]) GGSTParticle(*primaryParticle);
}

UInt_t GGSTMCTruthInfo::GetNPrimaries ( )

inline

Retrieves the number of primaries in this event.

Returns

The number of primary particles in the event

Definition at line 32 of file GGSTMCTruthInfo.h.

                         {
    if (_primaries)
      return _primaries->GetEntries();
    else
      return 0;
  }

GGSTParticle * GGSTMCTruthInfo::GetPrimaryParticle

(

UInt_t

particleNumber

)

Retrieves a primary particle.

Parameters

particleNumber

The particle to retrieve (0 is first particle).

Returns

Pointer to the primary particle object

NULL if particle number is not valid.

Definition at line 38 of file GGSTMCTruthInfo.cpp.

                                                                       {

  if (particleNumber < (UInt_t)(_primaries->GetEntries())) {
    return (GGSTParticle *)(_primaries->At(particleNumber));
  } else
    return NULL;
}

Field Documentation

UInt_t GGSTMCTruthInfo::nDiscarded

The number of discarded + killed events the current event and the previous event saved in file.

In case some condition is imposed on event generation (eg. acceptance check), some events may be discarded or killed before one is considered "good" and actually saved on file. This member stores the number of discarded + killed events between the current event on the output file and the previous one.

Definition at line 66 of file GGSTMCTruthInfo.h.

---

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

• GGSTMCTruthInfo.h
• GGSTMCTruthInfo.cpp