HepMC3 event record library
GenParticle.cc
Go to the documentation of this file.
1 // -*- C++ -*-
2 //
3 // This file is part of HepMC
4 // Copyright (C) 2014-2019 The HepMC collaboration (see AUTHORS for details)
5 //
6 /**
7  * @file GenParticle.cc
8  * @brief Implementation of \b class GenParticle
9  *
10  */
11 #include "HepMC3/GenParticle.h"
12 #include "HepMC3/GenVertex.h"
13 #include "HepMC3/GenEvent.h"
14 #include "HepMC3/Setup.h"
15 #include "HepMC3/Attribute.h"
16 
17 namespace HepMC3 {
18 
19 GenParticle::GenParticle( const FourVector &mom, int pidin, int stat):
20  m_event(nullptr),
21  m_id(0) {
22  m_data.pid = pidin;
23  m_data.momentum = mom;
24  m_data.status = stat;
25  m_data.is_mass_set = false;
26  m_data.mass = 0.0;
27 }
28 
30  m_event(nullptr),
31  m_id(0),
32  m_data(dat) {
33 }
34 
36  if(m_data.is_mass_set) return m_data.mass;
37  else return m_data.momentum.m();
38 }
39 
40 void GenParticle::set_pid(int pidin) {
41  m_data.pid = pidin;
42 }
43 
44 void GenParticle::set_status(int stat) {
45  m_data.status = stat;
46 }
47 
49  m_data.momentum = mom;
50 }
51 
53  m_data.mass = m;
54  m_data.is_mass_set = true;
55 }
56 
58  m_data.mass = 0.;
59  m_data.is_mass_set = false;
60 }
61 
63  return m_production_vertex.lock();
64 }
65 
66 ConstGenVertexPtr GenParticle::production_vertex() const {
67  return std::const_pointer_cast<const GenVertex>(m_production_vertex.lock());
68 }
69 
70 GenVertexPtr GenParticle::end_vertex() {
71  return m_end_vertex.lock();
72 }
73 
74 ConstGenVertexPtr GenParticle::end_vertex() const {
75  return std::const_pointer_cast<const GenVertex>(m_end_vertex.lock());
76 }
77 
78 std::vector<GenParticlePtr> GenParticle::parents() {
79  return (m_production_vertex.expired())? std::vector<GenParticlePtr>() : production_vertex()->particles_in();
80 }
81 
82 std::vector<ConstGenParticlePtr> GenParticle::parents() const {
83  return (m_production_vertex.expired()) ? std::vector<ConstGenParticlePtr>() : production_vertex()->particles_in();
84 }
85 
86 std::vector<GenParticlePtr> GenParticle::children() {
87  return (m_end_vertex.expired())? std::vector<GenParticlePtr>() : end_vertex()->particles_out();
88 }
89 
90 std::vector<ConstGenParticlePtr> GenParticle::children() const {
91  return (m_end_vertex.expired()) ? std::vector<ConstGenParticlePtr>() : end_vertex()->particles_out();
92 }
93 
94 bool GenParticle::add_attribute(const std::string& name, std::shared_ptr<Attribute> att) {
95  if ( !parent_event() ) return false;
96  parent_event()->add_attribute(name, att, id());
97  return true;
98 }
99 
100 std::vector<std::string> GenParticle::attribute_names() const {
101  if ( parent_event() ) return parent_event()->attribute_names(id());
102 
103  return std::vector<std::string>();
104 }
105 
106 void GenParticle::remove_attribute(const std::string& name) {
107  if ( parent_event() ) parent_event()->remove_attribute(name, id());
108 }
109 
110 std::string GenParticle::attribute_as_string(const std::string& name) const {
111  return parent_event() ? parent_event()->attribute_as_string(name, id()) : std::string();
112 }
113 
114 } // namespace HepMC3
GenParticle(const FourVector &momentum=FourVector::ZERO_VECTOR(), int pid=0, int status=0)
Default constructor.
Definition: GenParticle.cc:19
void set_status(int status)
Set status code.
Definition: GenParticle.cc:44
GenEvent * parent_event()
Get parent event.
Definition: GenParticle.h:58
void set_pid(int pid)
Set PDG ID.
Definition: GenParticle.cc:40
ConstGenVertexPtr production_vertex() const
Get production vertex (const version)
Definition: GenParticle.cc:66
void set_generated_mass(double m)
Set generated mass.
Definition: GenParticle.cc:52
Definition of class GenParticle.
Stores vertex-related information.
Definition: GenVertex.h:26
void remove_attribute(const std::string &name)
Remove attribute.
Definition: GenParticle.cc:106
std::weak_ptr< GenVertex > m_production_vertex
Production vertex.
Definition: GenParticle.h:148
Definition of class GenVertex.
std::vector< GenParticlePtr > parents()
Convenience access to immediate incoming particles via production vertex.
Definition: GenParticle.cc:78
void add_attribute(const std::string &name, const std::shared_ptr< Attribute > &att, const int &id=0)
Add event attribute to event.
Definition: GenEvent.h:208
GenParticleData m_data
Particle data.
Definition: GenParticle.h:146
FourVector momentum
Momentum.
std::string attribute_as_string(const std::string &name, const int &id=0) const
Get attribute of any type as string.
Definition: GenEvent.cc:798
Generic 4-vector.
Definition: FourVector.h:35
Stores serializable particle information.
double m() const
Invariant mass. Returns -sqrt(-m) if e^2 - P^2 is negative.
Definition: FourVector.h:164
ConstGenVertexPtr end_vertex() const
Get end vertex (const version)
Definition: GenParticle.cc:74
Definition of class Setup.
void remove_attribute(const std::string &name, const int &id=0)
Remove attribute.
Definition: GenEvent.cc:621
std::vector< GenParticlePtr > children()
Convenience access to immediate outgoing particles via end vertex.
Definition: GenParticle.cc:86
std::vector< std::string > attribute_names(const int &id=0) const
Get list of attribute names.
Definition: GenEvent.cc:633
std::string attribute_as_string(const std::string &name) const
Get attribute of any type as string.
Definition: GenParticle.cc:110
double mass
Generated mass (if set)
std::weak_ptr< GenVertex > m_end_vertex
End vertex.
Definition: GenParticle.h:149
Definition of class GenEvent.
void unset_generated_mass()
Declare that generated mass is not set.
Definition: GenParticle.cc:57
void set_momentum(const FourVector &momentum)
Set momentum.
Definition: GenParticle.cc:48
Annotation for function names.
Definition: attr.h:36
Definition of class Attribute, class IntAttribute and class StringAttribute.
std::vector< std::string > attribute_names() const
Get list of names of attributes assigned to this particle.
Definition: GenParticle.cc:100
bool add_attribute(const std::string &name, std::shared_ptr< Attribute > att)
Add an attribute to this particle.
Definition: GenParticle.cc:94
bool is_mass_set
Check if generated mass is set.
double generated_mass() const
Get generated mass.
Definition: GenParticle.cc:35