HepMC3 event record library
Generator Struct Reference

Detailed Description

The Generator class contains information about a generator used in a run.

Definition at line 492 of file LHEF.h.

#include <LHEF.h>

+ Inheritance diagram for Generator:
+ Collaboration diagram for Generator:

Public Types

typedef XMLTag::AttributeMap AttributeMap
 

Public Member Functions

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

Static Public Member Functions

static std::string yes ()
 

Data Fields

std::string name
 
std::string version
 
XMLTag::AttributeMap attributes
 
std::string contents
 

Member Typedef Documentation

◆ AttributeMap

Convenient typedef.

Definition at line 367 of file LHEF.h.

Constructor & Destructor Documentation

◆ Generator()

Generator ( const XMLTag & tag)
inline

Construct from XML tag.

Definition at line 497 of file LHEF.h.

References TagBase::contents, TagBase::getattr(), name, TagBase::TagBase(), and version.

Member Function Documentation

◆ closetag()

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

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

Definition at line 463 of file LHEF.h.

References contents.

◆ getattr() [1/5]

bool getattr ( const 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 400 of file LHEF.h.

References attributes.

◆ getattr() [2/5]

bool getattr ( const 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 386 of file LHEF.h.

References attributes.

◆ getattr() [3/5]

bool getattr ( const 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 428 of file LHEF.h.

References attributes.

◆ getattr() [4/5]

bool getattr ( const 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 414 of file LHEF.h.

References attributes.

◆ getattr() [5/5]

bool getattr ( const 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 442 of file LHEF.h.

References attributes.

◆ print()

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

Print the object as a generator tag.

Definition at line 506 of file LHEF.h.

References TagBase::closetag(), name, LHEF::oattr(), TagBase::printattrs(), and version.

◆ printattrs()

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

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

Definition at line 453 of file LHEF.h.

References attributes, and LHEF::oattr().

◆ yes()

static std::string yes ( )
inlinestaticinherited

Static string token for truth values.

Definition at line 485 of file LHEF.h.

Field Documentation

◆ attributes

XMLTag::AttributeMap attributes
inherited

The attributes of this tag;

Definition at line 475 of file LHEF.h.

◆ contents

std::string contents
mutableinherited

The contents of this tag.

Definition at line 480 of file LHEF.h.

◆ name

std::string name

The name of the generator.

Definition at line 517 of file LHEF.h.

◆ version

std::string version

The version of the generator.

Definition at line 522 of file LHEF.h.


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