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

Detailed Description

The Clus class represents a clustering of two particle entries into one as defined in a clustering tag.

Definition at line 1250 of file LHEF.h.

#include <LHEF.h>

+ Inheritance diagram for Clus:
+ Collaboration diagram for Clus:

Public Types

typedef XMLTag::AttributeMap AttributeMap
 

Public Member Functions

 Clus ()
 
 Clus (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

int p1
 
int p2
 
int p0
 
double scale
 
double alphas
 
XMLTag::AttributeMap attributes
 
std::string contents
 

Member Typedef Documentation

◆ AttributeMap

Convenient typedef.

Definition at line 350 of file LHEF.h.

Constructor & Destructor Documentation

◆ Clus() [1/2]

Clus ( )
inline

Initialize default values.

Definition at line 1255 of file LHEF.h.

◆ Clus() [2/2]

Clus ( const XMLTag tag)
inline

Initialize default values.

Definition at line 1260 of file LHEF.h.

References Clus::alphas, XMLTag::contents, TagBase::getattr(), Clus::p0, Clus::p1, Clus::p2, and Clus::scale.

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

References TagBase::contents.

◆ getattr() [1/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 382 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [2/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 368 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [3/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 410 of file LHEF.h.

References TagBase::attributes.

◆ getattr() [4/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 396 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 424 of file LHEF.h.

References TagBase::attributes.

◆ print()

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

Print out an XML tag.

Definition at line 1272 of file LHEF.h.

References Clus::alphas, LHEF::oattr(), Clus::p0, Clus::p1, Clus::p2, and Clus::scale.

◆ printattrs()

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().

◆ yes()

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 467 of file LHEF.h.

Field Documentation

◆ alphas

double alphas

The alpha_s used in the corresponding vertex, if this was used in the cross section.

Definition at line 1305 of file LHEF.h.

◆ attributes

XMLTag::AttributeMap attributes
inherited

The attributes of this tag;

Definition at line 457 of file LHEF.h.

◆ contents

std::string contents
mutableinherited

The contents of this tag.

Definition at line 462 of file LHEF.h.

◆ p0

int p0

The particle entry corresponding to the clustered particles.

Definition at line 1294 of file LHEF.h.

◆ p1

int p1

The first particle entry that has been clustered.

Definition at line 1284 of file LHEF.h.

◆ p2

int p2

The second particle entry that has been clustered.

Definition at line 1289 of file LHEF.h.

◆ scale

double scale

The scale in GeV associated with the clustering.

Definition at line 1299 of file LHEF.h.


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