hej is hosted by Hepforge, IPPP Durham
HEJ 2.1.4
High energy resummation for hadron colliders
Loading...
Searching...
No Matches
HEJ::EventReader Struct Referenceabstract

Abstract base class for reading events from files. More...

#include <EventReader.hh>

Inheritance diagram for HEJ::EventReader:

Public Member Functions

virtual bool read_event ()=0
 Read an event. More...
 
virtual std::string const & header () const =0
 Access header text. More...
 
virtual LHEF::HEPRUP const & heprup () const =0
 Access run information. More...
 
virtual LHEF::HEPEUP const & hepeup () const =0
 Access last read event. More...
 
virtual optional< std::size_t > number_events () const
 Guess number of events from header. More...
 
virtual ~EventReader ()=default
 

Detailed Description

Abstract base class for reading events from files.

Constructor & Destructor Documentation

◆ ~EventReader()

virtual HEJ::EventReader::~EventReader ( )
virtualdefault

Member Function Documentation

◆ header()

virtual std::string const & HEJ::EventReader::header ( ) const
pure virtual

Access header text.

Implemented in HEJ::BufferedEventReader, HEJ::HDF5Reader, and HEJ::LesHouchesReader.

◆ hepeup()

virtual LHEF::HEPEUP const & HEJ::EventReader::hepeup ( ) const
pure virtual

Access last read event.

Implemented in HEJ::BufferedEventReader, HEJ::HDF5Reader, and HEJ::LesHouchesReader.

◆ heprup()

virtual LHEF::HEPRUP const & HEJ::EventReader::heprup ( ) const
pure virtual

Access run information.

Implemented in HEJ::BufferedEventReader, HEJ::HDF5Reader, and HEJ::LesHouchesReader.

◆ number_events()

virtual optional< std::size_t > HEJ::EventReader::number_events ( ) const
inlinevirtual

Guess number of events from header.

Reimplemented in HEJ::BufferedEventReader, HEJ::HDF5Reader, and HEJ::SherpaLHEReader.

◆ read_event()

virtual bool HEJ::EventReader::read_event ( )
pure virtual

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