hej is hosted by Hepforge, IPPP Durham
HEJ 2.1.4
High energy resummation for hadron colliders
Loading...
Searching...
No Matches
HEJ::HDF5Reader Class Reference

Class for reading events from a file in the HDF5 file format. More...

#include <HDF5Reader.hh>

Inheritance diagram for HEJ::HDF5Reader:
Collaboration diagram for HEJ::HDF5Reader:

Public Member Functions

 HDF5Reader ()=delete
 
 HDF5Reader (std::string const &filename)
 Contruct object reading from the given file. More...
 
bool read_event () override
 Read an event. More...
 
std::string const & header () const override
 Access header text. More...
 
LHEF::HEPRUP const & heprup () const override
 Access run information. More...
 
LHEF::HEPEUP const & hepeup () const override
 Access last read event. More...
 
optional< size_t > number_events () const override
 Get number of events. More...
 
 ~HDF5Reader () override
 
- Public Member Functions inherited from HEJ::EventReader
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

Class for reading events from a file in the HDF5 file format.

This format is specified in [5].

Constructor & Destructor Documentation

◆ HDF5Reader() [1/2]

HEJ::HDF5Reader::HDF5Reader ( )
delete

◆ HDF5Reader() [2/2]

HEJ::HDF5Reader::HDF5Reader ( std::string const &  filename)
explicit

Contruct object reading from the given file.

◆ ~HDF5Reader()

HEJ::HDF5Reader::~HDF5Reader ( )
override

Member Function Documentation

◆ header()

std::string const & HEJ::HDF5Reader::header ( ) const
overridevirtual

Access header text.

Implements HEJ::EventReader.

◆ hepeup()

LHEF::HEPEUP const & HEJ::HDF5Reader::hepeup ( ) const
overridevirtual

Access last read event.

Implements HEJ::EventReader.

◆ heprup()

LHEF::HEPRUP const & HEJ::HDF5Reader::heprup ( ) const
overridevirtual

Access run information.

Implements HEJ::EventReader.

◆ number_events()

optional< size_t > HEJ::HDF5Reader::number_events ( ) const
overridevirtual

Get number of events.

Reimplemented from HEJ::EventReader.

◆ read_event()

bool HEJ::HDF5Reader::read_event ( )
overridevirtual

Read an event.

Implements HEJ::EventReader.


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