HepMC event record
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 1156 of file build/outputs/include/HepMC/LHEF.h.

#include <LHEF.h>

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

Public Types

typedef XMLTag::AttributeMap AttributeMap
 
typedef XMLTag::AttributeMap AttributeMap
 

Public Member Functions

 Clus ()
 
 Clus (const XMLTag &tag)
 
void print (std::ostream &file) const
 
 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)
 
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 printattrs (std::ostream &file) const
 
void closetag (std::ostream &file, std::string tag) const
 
void closetag (std::ostream &file, std::string tag) const
 

Static Public Member Functions

static std::string yes ()
 
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 [1/2]

Convenient typedef.

Definition at line 338 of file build/outputs/include/HepMC/LHEF.h.

◆ AttributeMap [2/2]

Convenient typedef.

Definition at line 338 of file include/HepMC/LHEF.h.

Constructor & Destructor Documentation

◆ Clus() [1/4]

Clus ( )
inline

Initialize default values.

Definition at line 1161 of file build/outputs/include/HepMC/LHEF.h.

◆ Clus() [2/4]

Clus ( const XMLTag tag)
inline

Initialize default values.

Definition at line 1166 of file build/outputs/include/HepMC/LHEF.h.

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

◆ Clus() [3/4]

Clus ( )
inline

Initialize default values.

Definition at line 1161 of file include/HepMC/LHEF.h.

◆ Clus() [4/4]

Clus ( const XMLTag tag)
inline

Initialize default values.

Definition at line 1166 of file include/HepMC/LHEF.h.

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

Member Function Documentation

◆ closetag() [1/2]

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 434 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::contents.

◆ closetag() [2/2]

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 434 of file include/HepMC/LHEF.h.

References TagBase::contents.

◆ getattr() [1/10]

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 357 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [2/10]

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 357 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [3/10]

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 371 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [4/10]

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 371 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [5/10]

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 385 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [6/10]

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 385 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [7/10]

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 399 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [8/10]

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 399 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [9/10]

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 413 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ getattr() [10/10]

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 413 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ print() [1/2]

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

Print out an XML tag.

Definition at line 1178 of file include/HepMC/LHEF.h.

References Clus::alphas, Clus::p0, Clus::p1, Clus::p2, and Clus::scale.

◆ print() [2/2]

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

Print out an XML tag.

Definition at line 1178 of file build/outputs/include/HepMC/LHEF.h.

References Clus::alphas, Clus::p0, Clus::p1, Clus::p2, and Clus::scale.

◆ printattrs() [1/2]

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

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

Definition at line 424 of file build/outputs/include/HepMC/LHEF.h.

References TagBase::attributes.

◆ printattrs() [2/2]

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

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

Definition at line 424 of file include/HepMC/LHEF.h.

References TagBase::attributes.

◆ yes() [1/2]

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 456 of file include/HepMC/LHEF.h.

◆ yes() [2/2]

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 456 of file build/outputs/include/HepMC/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 1211 of file build/outputs/include/HepMC/LHEF.h.

◆ attributes

XMLTag::AttributeMap attributes
inherited

The attributes of this tag;

Definition at line 446 of file build/outputs/include/HepMC/LHEF.h.

◆ contents

std::string contents
inherited

The contents of this tag.

Definition at line 451 of file build/outputs/include/HepMC/LHEF.h.

◆ p0

int p0

The particle entry corresponding to the clustered particles.

Definition at line 1200 of file build/outputs/include/HepMC/LHEF.h.

◆ p1

int p1

The first particle entry that has been clustered.

Definition at line 1190 of file build/outputs/include/HepMC/LHEF.h.

◆ p2

int p2

The second particle entry that has been clustered.

Definition at line 1195 of file build/outputs/include/HepMC/LHEF.h.

◆ scale

double scale

The scale in GeV associated with the clustering.

Definition at line 1205 of file build/outputs/include/HepMC/LHEF.h.


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