HepMC3 event record library
Public Member Functions | Protected Member Functions | Private Attributes
DoubleAttribute Class Reference

Detailed Description

Attribute that holds a real number as a double.

Examples:
LHEF_example_cat.cc.

Definition at line 242 of file Attribute.h.

#include <Attribute.h>

+ Inheritance diagram for DoubleAttribute:
+ Collaboration diagram for DoubleAttribute:

Public Member Functions

 DoubleAttribute ()
 Default constructor. More...
 
 DoubleAttribute (double val)
 Constructor initializing attribute value. More...
 
bool from_string (const std::string &att) override
 Implementation of Attribute::from_string. More...
 
bool to_string (std::string &att) const override
 Implementation of Attribute::to_string. More...
 
double value () const
 get the value associated to this Attribute. More...
 
void set_value (const double &d)
 set the value associated to this Attribute. More...
 
virtual bool init ()
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenRunInfo &)
 Optionally initialize the attribute after from_string. 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
 

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

Private Attributes

double m_val
 Attribute value. More...
 

Constructor & Destructor Documentation

◆ DoubleAttribute() [1/2]

DoubleAttribute ( )
inline

Default constructor.

Definition at line 246 of file Attribute.h.

◆ DoubleAttribute() [2/2]

DoubleAttribute ( double  val)
inline

Constructor initializing attribute value.

Definition at line 249 of file Attribute.h.

Member Function Documentation

◆ event()

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.

◆ from_string()

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

Implementation of Attribute::from_string.

Implements Attribute.

Definition at line 252 of file Attribute.h.

References DoubleAttribute::m_val.

◆ init() [1/2]

virtual bool init ( )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Reimplemented in HEPEUPAttribute.

Definition at line 82 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 91 of file Attribute.h.

◆ is_parsed()

bool is_parsed ( ) const
inlineinherited

Check if this attribute is parsed.

Definition at line 103 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 114 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 119 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 135 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 138 of file Attribute.h.

References Attribute::m_string.

◆ set_value()

void set_value ( const double &  d)
inline

set the value associated to this Attribute.

Definition at line 272 of file Attribute.h.

References DoubleAttribute::m_val.

◆ to_string()

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

Implementation of Attribute::to_string.

Implements Attribute.

Definition at line 258 of file Attribute.h.

References DoubleAttribute::m_val.

◆ unparsed_string()

const std::string& unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 106 of file Attribute.h.

References Attribute::m_string.

◆ value()

double value ( ) const
inline

get the value associated to this Attribute.

Definition at line 267 of file Attribute.h.

References DoubleAttribute::m_val.

◆ vertex() [1/2]

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.

◆ vertex() [2/2]

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

◆ m_val

double m_val
private

Attribute value.

Definition at line 278 of file Attribute.h.


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