HepMC3 event record library
Public Member Functions | Data Fields | Protected Member Functions | Private Attributes
HEPRUPAttribute Class Reference

Detailed Description

Class for storing data for LHEF run information.

Examples
LHEF_example_cat.cc.

Definition at line 26 of file LHEFAttributes.h.

#include <LHEFAttributes.h>

+ Inheritance diagram for HEPRUPAttribute:
+ Collaboration diagram for HEPRUPAttribute:

Public Member Functions

 HEPRUPAttribute ()
 Default constructor.
 
 HEPRUPAttribute (std::string s)
 Constructor from string.
 
virtual ~HEPRUPAttribute ()
 Virtual destructor.
 
virtual bool from_string (const std::string &att) override
 Fill class content from string.
 
virtual bool to_string (std::string &att) const override
 Fill string from class content.
 
void clear ()
 Clear this object.
 
virtual bool init ()
 Optionally initialize the attribute after from_string.
 
virtual bool init (const GenRunInfo &)
 Optionally initialize the attribute after from_string.
 
bool is_parsed () const
 Check if this attribute is parsed.
 
const std::string & unparsed_string () const
 Get unparsed string.
 
const GenEventevent () const
 
GenParticlePtr particle ()
 
ConstGenParticlePtr particle () const
 
GenVertexPtr vertex ()
 
ConstGenVertexPtr vertex () const
 

Data Fields

LHEF::HEPRUP heprup
 The actual HEPRUP object.
 
std::vector< LHEF::XMLTag * > tags
 The parsed XML-tags.
 

Protected Member Functions

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

Private Attributes

bool m_is_parsed
 Is this attribute parsed?
 
std::string m_string
 Raw (unparsed) string.
 
const GenEventm_event
 
GenParticlePtr m_particle
 controlling GenEvent object.
 
GenVertexPtr m_vertex
 Vertex to which assigned.
 

Constructor & Destructor Documentation

◆ HEPRUPAttribute() [1/2]

HEPRUPAttribute ( )
inline

Default constructor.

Definition at line 31 of file LHEFAttributes.h.

◆ HEPRUPAttribute() [2/2]

HEPRUPAttribute ( std::string  s)
inline

Constructor from string.

Definition at line 34 of file LHEFAttributes.h.

◆ ~HEPRUPAttribute()

virtual ~HEPRUPAttribute ( )
inlinevirtual

Virtual destructor.

Definition at line 37 of file LHEFAttributes.h.

References HEPRUPAttribute::clear().

Member Function Documentation

◆ clear()

void clear ( )

Clear this object.

Definition at line 16 of file LHEFAttributes.cc.

References HEPRUP::clear(), HEPRUPAttribute::heprup, and HEPRUPAttribute::tags.

◆ event()

const GenEvent * event ( ) const
inlineinherited

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

Definition at line 108 of file Attribute.h.

References Attribute::m_event.

◆ from_string()

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

Fill class content from string.

Implements Attribute.

Definition at line 22 of file LHEFAttributes.cc.

References HEPRUPAttribute::clear(), XMLTag::findXMLTags(), HEPRUPAttribute::heprup, and HEPRUPAttribute::tags.

◆ init() [1/2]

virtual bool init ( )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Reimplemented in HEPEUPAttribute.

Definition at line 81 of file Attribute.h.

◆ init() [2/2]

virtual bool init ( const GenRunInfo )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute.

Definition at line 90 of file Attribute.h.

◆ is_parsed()

bool is_parsed ( ) const
inlineinherited

Check if this attribute is parsed.

Definition at line 102 of file Attribute.h.

References Attribute::m_is_parsed.

◆ particle() [1/2]

GenParticlePtr particle ( )
inlineinherited

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

Definition at line 113 of file Attribute.h.

References Attribute::m_particle.

◆ particle() [2/2]

ConstGenParticlePtr particle ( ) const
inlineinherited

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

Definition at line 118 of file Attribute.h.

References Attribute::m_particle.

◆ set_is_parsed()

void set_is_parsed ( bool  flag)
inlineprotectedinherited

Set is_parsed flag.

Definition at line 134 of file Attribute.h.

References Attribute::m_is_parsed.

◆ set_unparsed_string()

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

Set unparsed string.

Definition at line 137 of file Attribute.h.

References Attribute::m_string.

◆ to_string()

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

Fill string from class content.

Implements Attribute.

Definition at line 34 of file LHEFAttributes.cc.

References HEPRUPAttribute::heprup, HEPRUP::NPRUP, HEPRUP::print(), and HEPRUPAttribute::tags.

◆ unparsed_string()

const std::string & unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 105 of file Attribute.h.

References Attribute::m_string.

◆ vertex() [1/2]

GenVertexPtr vertex ( )
inlineinherited

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

Definition at line 123 of file Attribute.h.

References Attribute::m_vertex.

◆ vertex() [2/2]

ConstGenVertexPtr vertex ( ) const
inlineinherited

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

Definition at line 128 of file Attribute.h.

References Attribute::m_vertex.

Field Documentation

◆ heprup

LHEF::HEPRUP heprup

The actual HEPRUP object.

Definition at line 57 of file LHEFAttributes.h.

◆ m_event

const GenEvent* m_event
privateinherited

Possibility to be aware of the

Definition at line 145 of file Attribute.h.

◆ m_is_parsed

bool m_is_parsed
privateinherited

Is this attribute parsed?

Definition at line 143 of file Attribute.h.

◆ m_particle

GenParticlePtr m_particle
privateinherited

controlling GenEvent object.

Particle to which assigned.

Definition at line 147 of file Attribute.h.

◆ m_string

std::string m_string
privateinherited

Raw (unparsed) string.

Definition at line 144 of file Attribute.h.

◆ m_vertex

GenVertexPtr m_vertex
privateinherited

Vertex to which assigned.

Definition at line 148 of file Attribute.h.

◆ tags

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

The parsed XML-tags.

Examples
LHEF_example_cat.cc.

Definition at line 60 of file LHEFAttributes.h.


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