HEJ::LesHouchesReader Class Reference

Class for reading events from a file in the Les Houches Event File format. More...

#include <LesHouchesReader.hh>

Inheritance diagram for HEJ::LesHouchesReader:

Collaboration diagram for HEJ::LesHouchesReader:

Public Member Functions
	LesHouchesReader (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...
std::optional< size_t >	number_events () const override
	Guess number of events from header. More...
double	scalefactor () const 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 std::optional< std::size_t >	number_events () const =0
	Guess number of events from header. More...
virtual double	scalefactor () const
virtual	~EventReader ()=default

Detailed Description

Class for reading events from a file in the Les Houches Event File format.

Constructor & Destructor Documentation

LesHouchesReader()

HEJ::LesHouchesReader::LesHouchesReader ( std::string const &  filename )

explicit

Contruct object reading from the given file.

Member Function Documentation

header()

std::string const & HEJ::LesHouchesReader::header ( ) const

inlineoverridevirtual

Access header text.

Implements HEJ::EventReader.

hepeup()

LHEF::HEPEUP const & HEJ::LesHouchesReader::hepeup ( ) const

inlineoverridevirtual

Access last read event.

Implements HEJ::EventReader.

heprup()

LHEF::HEPRUP const & HEJ::LesHouchesReader::heprup ( ) const

inlineoverridevirtual

Access run information.

Implements HEJ::EventReader.

number_events()

std::optional< size_t > HEJ::LesHouchesReader::number_events ( ) const

inlineoverridevirtual

Guess number of events from header.

Implements HEJ::EventReader.

read_event()

bool HEJ::LesHouchesReader::read_event ( )

overridevirtual

Read an event.

Implements HEJ::EventReader.

scalefactor()

double HEJ::LesHouchesReader::scalefactor ( ) const

inlineoverridevirtual

Reimplemented from HEJ::EventReader.

---

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

• /home/andersen/HEJProjects/website/build/hej/include/HEJ/LesHouchesReader.hh