![]() |
HepMC Reference DocumentationHepMC |
#include <GenCrossSection.h>
Public Member Functions | |
GenCrossSection () | |
~GenCrossSection () | |
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 |
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.
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.
HepMC::GenCrossSection::GenCrossSection | ( | ) | [inline] |
Definition at line 35 of file GenCrossSection.h.
HepMC::GenCrossSection::~GenCrossSection | ( | ) | [inline] |
Definition at line 40 of file GenCrossSection.h.
HepMC::GenCrossSection::GenCrossSection | ( | GenCrossSection const & | orig | ) |
void HepMC::GenCrossSection::clear | ( | ) |
Clear all GenCrossSection info (disables output of GenCrossSection until the cross section is set again)
Definition at line 52 of file GenCrossSection.cc.
double HepMC::GenCrossSection::cross_section | ( | ) | const [inline] |
cross section in pb
Definition at line 55 of file GenCrossSection.h.
Referenced by operator==(), and HepMC::GenEvent::write_cross_section().
double HepMC::GenCrossSection::cross_section_error | ( | ) | const [inline] |
error associated with this cross section in pb
Definition at line 57 of file GenCrossSection.h.
Referenced by operator==(), and HepMC::GenEvent::write_cross_section().
bool HepMC::GenCrossSection::is_set | ( | ) | const [inline] |
True if the cross section has been set. False by default.
Definition at line 60 of file GenCrossSection.h.
Referenced by write().
bool HepMC::GenCrossSection::operator!= | ( | const GenCrossSection & | ) | const |
GenCrossSection & HepMC::GenCrossSection::operator= | ( | GenCrossSection const & | rhs | ) |
bool HepMC::GenCrossSection::operator== | ( | const GenCrossSection & | ) | const |
check for equality
Definition at line 39 of file GenCrossSection.cc.
References cross_section(), and cross_section_error().
std::istream & HepMC::GenCrossSection::read | ( | std::istream & | ) |
read from an input stream
Definition at line 76 of file GenCrossSection.cc.
References set_cross_section().
Referenced by HepMC::operator>>().
void HepMC::GenCrossSection::set_cross_section | ( | double | ) | [inline] |
void HepMC::GenCrossSection::set_cross_section | ( | double | xs, | |
double | xs_err | |||
) | [inline] |
Set cross section and error in pb.
Definition at line 98 of file GenCrossSection.h.
References set_cross_section_error().
Referenced by read().
void HepMC::GenCrossSection::set_cross_section_error | ( | double | ) | [inline] |
set error associated with this cross section in pb
Definition at line 109 of file GenCrossSection.h.
Referenced by set_cross_section().
void HepMC::GenCrossSection::swap | ( | GenCrossSection & | other | ) |
swap
Definition at line 25 of file GenCrossSection.cc.
References m_cross_section, m_cross_section_error, and m_is_set.
Referenced by operator=().
std::ostream & HepMC::GenCrossSection::write | ( | std::ostream & | ) | const |
write to an output stream
Definition at line 59 of file GenCrossSection.cc.
References is_set().
Referenced by HepMC::operator<<(), and HepMC::GenEvent::write().