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

Detailed Description

The XSecInfo class contains information given in the xsecinfo tag.

Definition at line 512 of file LHEF.h.

#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
 

Member Typedef Documentation

◆ AttributeMap

Convenient typedef.

Definition at line 350 of file LHEF.h.

Constructor & Destructor Documentation

◆ XSecInfo() [1/2]

XSecInfo ( )
inline

Intitialize default values.

Definition at line 517 of file LHEF.h.

◆ XSecInfo() [2/2]

XSecInfo ( const XMLTag tag)
inline

Member Function Documentation

◆ closetag()

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 446 of file LHEF.h.

References TagBase::contents.

◆ getattr() [1/5]

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 369 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [2/5]

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 383 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [3/5]

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 397 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [4/5]

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 411 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [5/5]

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 425 of file LHEF.h.

References TagBase::attributes.

◆ print()

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

◆ printattrs()

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

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

Definition at line 436 of file LHEF.h.

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

◆ yes()

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 468 of file LHEF.h.

Field Documentation

◆ attributes

XMLTag::AttributeMap attributes
inherited

The attributes of this tag;

Definition at line 458 of file LHEF.h.

◆ contents

std::string contents
mutableinherited

The contents of this tag.

Definition at line 463 of file LHEF.h.

◆ maxweight

double maxweight

The maximum weight.

Definition at line 585 of file LHEF.h.

◆ meanweight

double meanweight

The average weight.

Definition at line 590 of file LHEF.h.

◆ negweights

bool negweights

Does the file contain negative weights?

Definition at line 595 of file LHEF.h.

◆ neve

long neve

The number of events.

Definition at line 565 of file LHEF.h.

◆ ntries

long ntries

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

Definition at line 570 of file LHEF.h.

◆ totxsec

double totxsec

The total cross section in pb.

Definition at line 575 of file LHEF.h.

◆ varweights

bool varweights

Does the file contain varying weights?

Definition at line 600 of file LHEF.h.

◆ weightname

std::string weightname

The named weight to which this object belongs.

Definition at line 605 of file LHEF.h.

◆ xsecerr

double xsecerr

The estimated statistical error on totxsec.

Definition at line 580 of file LHEF.h.


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