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

Detailed Description

Simple struct to store information about separate eventfiles to be loaded.

Definition at line 617 of file LHEF.h.

#include <LHEF.h>

+ Inheritance diagram for EventFile:
+ Collaboration diagram for EventFile:

Public Types

typedef XMLTag::AttributeMap AttributeMap
 

Public Member Functions

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

std::string filename
 
long neve
 
long ntries
 
XMLTag::AttributeMap attributes
 
std::string contents
 

Member Typedef Documentation

◆ AttributeMap

Convenient typedef.

Definition at line 350 of file LHEF.h.

Constructor & Destructor Documentation

◆ EventFile() [1/2]

EventFile ( )
inline

Intitialize default values.

Definition at line 622 of file LHEF.h.

◆ EventFile() [2/2]

EventFile ( const XMLTag tag)
inline

Create from XML tag

Definition at line 627 of file LHEF.h.

References EventFile::filename, TagBase::getattr(), EventFile::neve, and EventFile::ntries.

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

References TagBase::closetag(), EventFile::filename, EventFile::neve, EventFile::ntries, LHEF::oattr(), and TagBase::printattrs().

◆ 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

◆ 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.

◆ filename

std::string filename

The name of the file.

Definition at line 652 of file LHEF.h.

◆ neve

long neve

The number of events.

Definition at line 657 of file LHEF.h.

◆ ntries

long ntries

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

Definition at line 662 of file LHEF.h.


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