HepMC::GenCrossSection Class Reference

The GenCrossSection class stores the generated cross section. More...

#include <GenCrossSection.h>

Public Member Functions
	GenCrossSection (GenCrossSection const &orig)
	copy
void	swap (GenCrossSection &other)
	swap
GenCrossSection &	operator= (GenCrossSection const &rhs)
bool	operator== (const GenCrossSection &) const
	check for equality
bool	operator!= (const GenCrossSection &) const
	check for inequality
double	cross_section () const
	cross section in pb
double	cross_section_error () const
	error associated with this cross section in pb
bool	is_set () const
	True if the cross section has been set. False by default.
void	set_cross_section (double xs, double xs_err)
	Set cross section and error in pb.
void	set_cross_section (double)
	set cross section in pb
void	set_cross_section_error (double)
	set error associated with this cross section in pb
void	clear ()
std::ostream &	write (std::ostream &) const
	write to an output stream
std::istream &	read (std::istream &)
	read from an input stream

Detailed Description

The GenCrossSection class stores the generated cross section.

HepMC::GenCrossSection is used to store the generated cross section. This class is meant to be used to pass, on an event by event basis, the current best guess of the total cross section. It is expected that the final cross section will be stored elsewhere.

• double cross_section; // cross section in pb
• double cross_section_error; // error associated with this cross section

The units of cross_section and cross_section_error are expected to be pb.

GenCrossSection information will be written if GenEvent contains a pointer to a valid GenCrossSection object.

Definition at line 32 of file GenCrossSection.h.

Member Function Documentation

void HepMC::GenCrossSection::clear

(

void

)

Clear all GenCrossSection info (disables output of GenCrossSection until the cross section is set again)

Definition at line 52 of file GenCrossSection.cc.

GenCrossSection & HepMC::GenCrossSection::operator=

(

GenCrossSection const &

rhs

)

shallow

Definition at line 32 of file GenCrossSection.cc.

References swap().

---

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

• StarGenerator/HepMC2_06_09/HepMC/GenCrossSection.h
• StarGenerator/HepMC2_06_09/src/GenCrossSection.cc