HepMC3 event record library
Public Types | Public Member Functions | Static Public Member Functions | Data Fields
XSecInfo Struct Reference

#include <LHEF.h>

+ Inheritance diagram for XSecInfo:
+ Collaboration diagram for XSecInfo:

Public Types

typedef XMLTag::AttributeMap AttributeMap
 

Public Member Functions

 XSecInfo ()
 
 XSecInfo (const XMLTag &tag)
 
void print (std::ostream &file) const
 
bool getattr (std::string n, double &v, bool erase=true)
 
bool getattr (std::string n, bool &v, bool erase=true)
 
bool getattr (std::string n, long &v, bool erase=true)
 
bool getattr (std::string n, int &v, bool erase=true)
 
bool getattr (std::string n, std::string &v, bool erase=true)
 
void printattrs (std::ostream &file) const
 
void closetag (std::ostream &file, std::string tag) const
 

Static Public Member Functions

static std::string yes ()
 

Data Fields

long neve
 
long ntries
 
double totxsec
 
double xsecerr
 
double maxweight
 
double meanweight
 
bool negweights
 
bool varweights
 
std::string weightname
 
XMLTag::AttributeMap attributes
 
std::string contents
 

Detailed Description

The XSecInfo class contains information given in the xsecinfo tag.

Definition at line 511 of file LHEF.h.

Member Typedef Documentation

Convenient typedef.

Definition at line 350 of file LHEF.h.

Constructor & Destructor Documentation

XSecInfo ( )
inline

Intitialize default values.

Definition at line 516 of file LHEF.h.

XSecInfo ( const XMLTag tag)
inline

Member Function Documentation

void closetag ( std::ostream &  file,
std::string  tag 
) const
inlineinherited

Print out end of tag marker. Print contents if not empty else print simple close tag.

Definition at line 445 of file LHEF.h.

References TagBase::contents.

bool getattr ( std::string  n,
double &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the double variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 368 of file LHEF.h.

References TagBase::attributes.

bool getattr ( std::string  n,
bool &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the bool variable v to true if the corresponding value is "yes". Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 382 of file LHEF.h.

References TagBase::attributes.

bool getattr ( std::string  n,
long &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the long variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 396 of file LHEF.h.

References TagBase::attributes.

bool getattr ( std::string  n,
int &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the long variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 410 of file LHEF.h.

References TagBase::attributes.

bool getattr ( std::string  n,
std::string &  v,
bool  erase = true 
)
inlineinherited

Find an attribute named n and set the string variable v to the corresponding value. Remove the correspondig attribute from the list if found and erase is true.

Returns
false if no attribute was found.

Definition at line 424 of file LHEF.h.

References TagBase::attributes.

void print ( std::ostream &  file) const
inline
void printattrs ( std::ostream &  file) const
inlineinherited

print out ' name="value"' for all unparsed attributes.

Definition at line 435 of file LHEF.h.

References TagBase::attributes, and LHEF::oattr().

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 467 of file LHEF.h.

Field Documentation

XMLTag::AttributeMap attributes
inherited

The attributes of this tag;

Definition at line 457 of file LHEF.h.

std::string contents
mutableinherited

The contents of this tag.

Definition at line 462 of file LHEF.h.

double maxweight

The maximum weight.

Definition at line 584 of file LHEF.h.

double meanweight

The average weight.

Definition at line 589 of file LHEF.h.

bool negweights

Does the file contain negative weights?

Definition at line 594 of file LHEF.h.

long neve

The number of events.

Definition at line 564 of file LHEF.h.

long ntries

The number of attempte that was needed to produce the neve events.

Definition at line 569 of file LHEF.h.

double totxsec

The total cross section in pb.

Definition at line 574 of file LHEF.h.

bool varweights

Does the file contain varying weights?

Definition at line 599 of file LHEF.h.

std::string weightname

The named weight to which this object belongs.

Definition at line 604 of file LHEF.h.

double xsecerr

The estimated statistical error on totxsec.

Definition at line 579 of file LHEF.h.


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