HEJ::BufferedEventReader Class Reference

Event reader with internal buffer. More...

#include <BufferedEventReader.hh>

Inheritance diagram for HEJ::BufferedEventReader:

Collaboration diagram for HEJ::BufferedEventReader:

Public Member Functions
	BufferedEventReader (std::unique_ptr< EventReader > reader)
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< std::size_t >	number_events () const override
	Guess number of events from header. More...
template<class... T>
void	emplace (T &&... args)
	Push event back into reader. More...
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

Event reader with internal buffer.

Having a buffer makes it possible to put events back into the reader so that they are read again

Constructor & Destructor Documentation

BufferedEventReader()

HEJ::BufferedEventReader::BufferedEventReader ( std::unique_ptr< EventReader >  reader )

inlineexplicit

Member Function Documentation

emplace()

template<class... T>

void HEJ::BufferedEventReader::emplace ( T &&...  args )

inline

Push event back into reader.

header()

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

inlineoverridevirtual

Access header text.

Implements HEJ::EventReader.

hepeup()

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

inlineoverridevirtual

Access last read event.

Implements HEJ::EventReader.

heprup()

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

inlineoverridevirtual

Access run information.

Implements HEJ::EventReader.

number_events()

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

inlineoverridevirtual

Guess number of events from header.

Implements HEJ::EventReader.

read_event()

bool HEJ::BufferedEventReader::read_event ( )

overridevirtual

Read an event.

Implements HEJ::EventReader.

---

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

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