class Rivet::Run

Rivet::Run

Interface to handle a run of events read from a HepMC stream or file.

#include <Run.hh>

Public Functions

Name
Run &setCrossSection(double xs)
Get the cross-section for this run.
Run &setListAnalyses(bool dolist)
Declare whether to list available analyses.
boolinit(const std::string & evtfile, double weight =1.0)
Set up HepMC file readers (using the appropriate file weight for the first file)
boolopenFile(const std::string & evtfile, double weight =1.0)
Open a HepMC GenEvent file (using the appropriate file weight for the first file)
boolreadEvent()
Read the next HepMC event.
size_tnumEvents() const
Read the next HepMC event only to skip it.
boolprocessEvent()
Handle next event.
boolfinalize()
Close up HepMC I/O.
Run(AnalysisHandler & ah)
Standard constructor.
~Run()
Destructor.

Public Functions Documentation

function setCrossSection

Run & setCrossSection(
    double xs
)

Get the cross-section for this run.

function setListAnalyses

Run & setListAnalyses(
    bool dolist
)

Declare whether to list available analyses.

function init

bool init(
    const std::string & evtfile,
    double weight =1.0
)

Set up HepMC file readers (using the appropriate file weight for the first file)

function openFile

bool openFile(
    const std::string & evtfile,
    double weight =1.0
)

Open a HepMC GenEvent file (using the appropriate file weight for the first file)

function readEvent

bool readEvent()

Read the next HepMC event.

function numEvents

inline size_t numEvents() const

Read the next HepMC event only to skip it.

Return the number of (collapsed) events read in from HepMC, including current partial event in case of sub-events

function processEvent

bool processEvent()

Handle next event.

function finalize

bool finalize()

Close up HepMC I/O.

function Run

Run(
    AnalysisHandler & ah
)

Standard constructor.

function ~Run

~Run()

Destructor.


Updated on 2022-08-07 at 20:17:17 +0100