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

Pure abstract base class for event writers. More...

#include <EventWriter.hh>

Inheritance diagram for HEJ::EventWriter:

Public Member Functions

virtual void write (Event const &)=0
 Write an event. More...
 
virtual void finish ()
 
virtual ~EventWriter ()=default
 

Protected Member Functions

void finish_or_abort (EventWriter *writer, std::string const &name) const noexcept
 If writer is not finished run finish() and abort on error. More...
 
bool finished () const
 

Detailed Description

Pure abstract base class for event writers.

Constructor & Destructor Documentation

◆ ~EventWriter()

virtual HEJ::EventWriter::~EventWriter ( )
virtualdefault

Member Function Documentation

◆ finish()

virtual void HEJ::EventWriter::finish ( )
inlinevirtual

Finish writing, e.g. write out general informations at end of run

Warning
using the writer after finishing is not guaranteed to work

Reimplemented in HEJ::CombinedEventWriter, HEJ::HDF5Writer, HEJ::HepMC3Writer, and HEJ::LesHouchesWriter.

◆ finish_or_abort()

void HEJ::EventWriter::finish_or_abort ( EventWriter writer,
std::string const &  name 
) const
protectednoexcept

If writer is not finished run finish() and abort on error.

Parameters
writerwriter that is expected to finish, i.e. this
namename for error message

Used in the destructor of inherited EventWriter to force finish()

Warning
When finish() failed this will abort the whole program!

◆ finished()

bool HEJ::EventWriter::finished ( ) const
inlineprotected

◆ write()

virtual void HEJ::EventWriter::write ( Event const &  )
pure virtual

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