HepMC3 event record library
Public Member Functions | Data Fields | Protected Member Functions
HEPEUPAttribute Class Reference

Class for storing data for LHEF run information. More...

#include <LHEFAttributes.h>

+ Inheritance diagram for HEPEUPAttribute:
+ Collaboration diagram for HEPEUPAttribute:

Public Member Functions

 HEPEUPAttribute ()
 Default constructor. More...
 
 HEPEUPAttribute (std::string s)
 Constructor from string. More...
 
virtual ~HEPEUPAttribute ()
 Virtual destructor. More...
 
virtual bool from_string (const std::string &att) override
 Fill class content from string. More...
 
virtual bool init () override
 Parse the XML-tags. More...
 
virtual bool init (const GenRunInfo &) override
 Dummy function. More...
 
virtual bool to_string (std::string &att) const override
 Fill string from class content. More...
 
FourVector momentum (int i) const
 Get momentum. More...
 
void clear ()
 Clear this object. More...
 
bool is_parsed () const
 Check if this attribute is parsed. More...
 
const std::string & unparsed_string () const
 Get unparsed string. More...
 
const GenEventevent () const
 
GenParticlePtr particle ()
 
ConstGenParticlePtr particle () const
 
GenVertexPtr vertex ()
 
ConstGenVertexPtr vertex () const
 

Data Fields

LHEF::HEPEUP hepeup
 The actual HEPEUP object. More...
 
std::vector< LHEF::XMLTag * > tags
 The parsed XML-tags. More...
 

Protected Member Functions

void set_is_parsed (bool flag)
 Set is_parsed flag. More...
 
void set_unparsed_string (const std::string &st)
 Set unparsed string. More...
 

Detailed Description

Class for storing data for LHEF run information.

Examples:
LHEF_example_cat.cc.

Definition at line 68 of file LHEFAttributes.h.

Constructor & Destructor Documentation

HEPEUPAttribute ( )
inline

Default constructor.

Definition at line 73 of file LHEFAttributes.h.

HEPEUPAttribute ( std::string  s)
inline

Constructor from string.

Definition at line 76 of file LHEFAttributes.h.

virtual ~HEPEUPAttribute ( )
inlinevirtual

Virtual destructor.

Definition at line 79 of file LHEFAttributes.h.

References HEPEUPAttribute::clear().

Member Function Documentation

void clear ( )

Clear this object.

Definition at line 44 of file LHEFAttributes.cc.

References HEPEUP::clear(), HEPEUPAttribute::hepeup, and HEPEUPAttribute::tags.

const GenEvent* event ( ) const
inlineinherited

return the GenEvent to which this Attribute belongs, if at all.

Definition at line 109 of file Attribute.h.

References Attribute::m_event.

bool from_string ( const std::string &  att)
overridevirtual

Fill class content from string.

Implements Attribute.

Definition at line 50 of file LHEFAttributes.cc.

References HEPEUPAttribute::clear(), XMLTag::findXMLTags(), and HEPEUPAttribute::tags.

bool init ( )
overridevirtual

Parse the XML-tags.

Reimplemented from Attribute.

Definition at line 70 of file LHEFAttributes.cc.

References GenEvent::attribute(), Attribute::event(), HEPEUPAttribute::hepeup, and HEPEUPAttribute::tags.

virtual bool init ( const GenRunInfo )
inlineoverridevirtual

Dummy function.

Reimplemented from Attribute.

Definition at line 94 of file LHEFAttributes.h.

bool is_parsed ( ) const
inlineinherited

Check if this attribute is parsed.

Definition at line 103 of file Attribute.h.

References Attribute::m_is_parsed.

FourVector momentum ( int  i) const
inline

Get momentum.

Definition at line 104 of file LHEFAttributes.h.

References HEPEUPAttribute::hepeup, and HEPEUP::PUP.

GenParticlePtr particle ( )
inlineinherited

return the GenParticle to which this Attribute belongs, if at all.

Definition at line 114 of file Attribute.h.

References Attribute::m_particle.

ConstGenParticlePtr particle ( ) const
inlineinherited

return the GenParticle to which this Attribute belongs, if at all.

Definition at line 119 of file Attribute.h.

References Attribute::m_particle.

void set_is_parsed ( bool  flag)
inlineprotectedinherited

Set is_parsed flag.

Definition at line 135 of file Attribute.h.

References Attribute::m_is_parsed.

void set_unparsed_string ( const std::string &  st)
inlineprotectedinherited

Set unparsed string.

Definition at line 138 of file Attribute.h.

References Attribute::m_string.

bool to_string ( std::string &  att) const
overridevirtual

Fill string from class content.

Implements Attribute.

Definition at line 59 of file LHEFAttributes.cc.

References HEPEUPAttribute::hepeup, HEPEUP::heprup, HEPEUP::print(), and HEPEUPAttribute::tags.

const std::string& unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 106 of file Attribute.h.

References Attribute::m_string.

GenVertexPtr vertex ( )
inlineinherited

return the GenVertex to which this Attribute belongs, if at all.

Definition at line 124 of file Attribute.h.

References Attribute::m_vertex.

ConstGenVertexPtr vertex ( ) const
inlineinherited

return the GenVertex to which this Attribute belongs, if at all.

Definition at line 129 of file Attribute.h.

References Attribute::m_vertex.

Field Documentation

LHEF::HEPEUP hepeup

The actual HEPEUP object.

Definition at line 113 of file LHEFAttributes.h.

std::vector<LHEF::XMLTag*> tags

The parsed XML-tags.

Examples:
LHEF_example_cat.cc.

Definition at line 116 of file LHEFAttributes.h.


The documentation for this class was generated from the following files: