HepMC3 event record library
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.
 DoubleAttribute (double val)
 Constructor initializing attribute value.
bool from_string (const string &att)
 Implementation of Attribute::from_string.
bool to_string (string &att) const
 Implementation of Attribute::to_string.
double value () const
 get the value associated to this Attribute.
void set_value (const double &d)
 set the value associated to this Attribute.
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 stringunparsed_string () const
 Get unparsed string.
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.
void set_unparsed_string (const string &st)
 Set unparsed string.

Private Attributes

double m_val
 Attribute value.
bool m_is_parsed
 Is this attribute parsed?
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

◆ DoubleAttribute() [1/2]

DoubleAttribute ( )
inline

Default constructor.

Definition at line 246 of file Attribute.h.

References Attribute::Attribute(), and m_val.

◆ DoubleAttribute() [2/2]

DoubleAttribute ( double val)
inline

Constructor initializing attribute value.

Definition at line 249 of file Attribute.h.

References Attribute::Attribute(), and m_val.

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 GenEvent, and m_event.

◆ from_string()

bool from_string ( const string & att)
inlinevirtual

Implementation of Attribute::from_string.

Implements Attribute.

Definition at line 252 of file Attribute.h.

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

◆ set_unparsed_string()

void set_unparsed_string ( const string & st)
inlineprotectedinherited

Set unparsed string.

Definition at line 138 of file Attribute.h.

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

◆ to_string()

bool to_string ( string & att) const
inlinevirtual

Implementation of Attribute::to_string.

Implements Attribute.

Definition at line 258 of file Attribute.h.

References m_val.

◆ unparsed_string()

const string & unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 106 of file Attribute.h.

References m_string.

◆ value()

double value ( ) const
inline

get the value associated to this Attribute.

Definition at line 267 of file Attribute.h.

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

Field Documentation

◆ m_event

const GenEvent* m_event
privateinherited

Possibility to be aware of the

Definition at line 146 of file Attribute.h.

◆ m_is_parsed

bool m_is_parsed
privateinherited

Is this attribute parsed?

Definition at line 144 of file Attribute.h.

◆ m_particle

GenParticlePtr m_particle
privateinherited

controlling GenEvent object.

Particle to which assigned.

Definition at line 148 of file Attribute.h.

◆ m_string

string m_string
privateinherited

Raw (unparsed) string.

Definition at line 145 of file Attribute.h.

◆ m_val

double m_val
private

Attribute value.

Definition at line 278 of file Attribute.h.

◆ m_vertex

GenVertexPtr m_vertex
privateinherited

Vertex to which assigned.

Definition at line 149 of file Attribute.h.


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