eic-smear  1.0.3
A collection of ROOT classes for Monte Carlo events and a fast-smearing code simulating detector effects for the Electron-Ion Collider task force
Public Types | Public Member Functions | List of all members
erhic::VirtualEvent Class Referenceabstract

Abstract base class for a physics event. More...

#include <VirtualEvent.h>

Inheritance diagram for erhic::VirtualEvent:
erhic::EventDis erhic::hadronic::EventMC erhic::hadronic::EventSmear erhic::EventMC Smear::Event erhic::hadronic::EventPythiaPP erhic::EventDjangoh erhic::EventDpmjet erhic::EventGmcTrans erhic::EventMilou erhic::EventPepsi erhic::EventPythia erhic::EventRapgap erhic::EventBeagle

Public Types

typedef std::vector< const erhic::VirtualParticle * > ParticlePtrList
 typedef for a track pointer collection. More...
 

Public Member Functions

virtual ~VirtualEvent ()
 Destructor. More...
 
virtual const VirtualParticle * GetTrack (UInt_t) const =0
 Returns the nth track from the event. More...
 
virtual VirtualParticle * GetTrack (UInt_t)=0
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual UInt_t GetNTracks () const =0
 Returns the number of tracks in the event. More...
 
virtual void HadronicFinalState (ParticlePtrList &) const
 Populate a track list with the hadronic final-state. More...
 

Detailed Description

Abstract base class for a physics event.

Defines an "event" simply as a collection of tracks.

Definition at line 25 of file VirtualEvent.h.

Member Typedef Documentation

◆ ParticlePtrList

typedef std::vector<const erhic::VirtualParticle*> erhic::VirtualEvent::ParticlePtrList

typedef for a track pointer collection.

Definition at line 52 of file VirtualEvent.h.

Constructor & Destructor Documentation

◆ ~VirtualEvent()

virtual erhic::VirtualEvent::~VirtualEvent ( )
inlinevirtual

Destructor.

Definition at line 30 of file VirtualEvent.h.

Member Function Documentation

◆ GetNTracks()

virtual UInt_t erhic::VirtualEvent::GetNTracks ( ) const
pure virtual

Returns the number of tracks in the event.

Implemented in erhic::EventMC, erhic::hadronic::EventMC, Smear::Event, and erhic::hadronic::EventSmear.

◆ GetTrack() [1/2]

virtual const VirtualParticle* erhic::VirtualEvent::GetTrack ( UInt_t  ) const
pure virtual

Returns the nth track from the event.

Indices run from 0 to (n-1).

Implemented in erhic::EventMC, Smear::Event, erhic::hadronic::EventMC, and erhic::hadronic::EventSmear.

◆ GetTrack() [2/2]

virtual VirtualParticle* erhic::VirtualEvent::GetTrack ( UInt_t  )
pure virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Implemented in erhic::EventMC, Smear::Event, erhic::hadronic::EventMC, and erhic::hadronic::EventSmear.

◆ HadronicFinalState()

virtual void erhic::VirtualEvent::HadronicFinalState ( ParticlePtrList &  ) const
inlinevirtual

Populate a track list with the hadronic final-state.

Reimplemented in erhic::EventMC, and Smear::Event.

Definition at line 57 of file VirtualEvent.h.

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