HEJ::LesHouchesWriter Class Reference

Class for writing events to a file in the Les Houches Event File format. More...

#include <LesHouchesWriter.hh>

Inheritance diagram for HEJ::LesHouchesWriter:

Collaboration diagram for HEJ::LesHouchesWriter:

Public Member Functions
	LesHouchesWriter (std::string const &file, LHEF::HEPRUP heprup)
	Constructor. More...
	LesHouchesWriter (std::string const &file, LHEF::HEPRUP heprup, std::string_view config)
	Constructor. More...
	LesHouchesWriter (LesHouchesWriter const &other)=delete
LesHouchesWriter &	operator= (LesHouchesWriter const &other)=delete
	LesHouchesWriter (LesHouchesWriter &&other)=delete
LesHouchesWriter &	operator= (LesHouchesWriter &&other)=delete
	~LesHouchesWriter () override
void	write (Event const &ev) override
	Write an event to the file specified in the constructor. More...
void	set_xs_scale (double scale) override
	Set the ratio (cross section) / (sum of event weights) More...
void	finish () override
	Dump general information & finish writing. More...
Public Member Functions inherited from HEJ::EventWriter
virtual	~EventWriter ()=default

Additional Inherited Members
Protected Member Functions inherited from HEJ::EventWriter
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

Class for writing events to a file in the Les Houches Event File format.

Constructor & Destructor Documentation

LesHouchesWriter() [1/4]

HEJ::LesHouchesWriter::LesHouchesWriter	(	std::string const &	file,
		LHEF::HEPRUP	heprup
	)

Constructor.

Parameters

file	Name of output file
heprup	General process information

LesHouchesWriter() [2/4]

HEJ::LesHouchesWriter::LesHouchesWriter	(	std::string const &	file,
		LHEF::HEPRUP	heprup,
		std::string_view	config
	)

Constructor.

Parameters

file	Name of output file
heprup	General process information
config	Generator configuration (e.g. a run card)

This constructor will write the start of an event file in the LesHouches Event File format to the given output file. Both the header and the init block according to the information in heprup will be written. If heprup.generators is non-empty, the header block will contain an XML element containing the configuration passed via the config argument. The name of the XML element is the last element of heprup.generators with all spaces removed.

LesHouchesWriter() [3/4]

HEJ::LesHouchesWriter::LesHouchesWriter ( LesHouchesWriter const &  other )

delete

LesHouchesWriter() [4/4]

HEJ::LesHouchesWriter::LesHouchesWriter ( LesHouchesWriter &&  other )

delete

Todo:

in principle, this class should be movable but that somehow(?) breaks the write member function

~LesHouchesWriter()

HEJ::LesHouchesWriter::~LesHouchesWriter ( )

override

Member Function Documentation

finish()

void HEJ::LesHouchesWriter::finish ( )

overridevirtual

Dump general information & finish writing.

Reimplemented from HEJ::EventWriter.

operator=() [1/2]

LesHouchesWriter& HEJ::LesHouchesWriter::operator= ( LesHouchesWriter &&  other )

delete

operator=() [2/2]

LesHouchesWriter& HEJ::LesHouchesWriter::operator= ( LesHouchesWriter const &  other )

delete

set_xs_scale()

void HEJ::LesHouchesWriter::set_xs_scale ( double  scale )

overridevirtual

Set the ratio (cross section) / (sum of event weights)

Implements HEJ::EventWriter.

write()

void HEJ::LesHouchesWriter::write ( Event const &  ev )

overridevirtual

Write an event to the file specified in the constructor.

Implements HEJ::EventWriter.

---

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

• /home/amaier/tmp/website/build/hej/include/HEJ/LesHouchesWriter.hh