HepMC3 event record library
|
Stores vertex-related information.
Definition at line 29 of file GenVertex.h.
#include <GenVertex.h>
Public Member Functions | |
Constructors | |
GenVertex (const FourVector &position=FourVector::ZERO_VECTOR()) | |
Default constructor. | |
GenVertex (const GenVertexData &data) | |
Constructor based on vertex data. | |
Accessors | |
GenEvent * | parent_event () |
Get parent event. | |
const GenEvent * | parent_event () const |
Get parent event. | |
bool | in_event () const |
Check if this vertex belongs to an event. | |
int | id () const |
int | status () const |
Get vertex status code. | |
void | set_status (int stat) |
Set vertex status code. | |
const GenVertexData & | data () const |
Get vertex data. | |
void | add_particle_in (GenParticlePtr p) |
Add incoming particle. | |
void | add_particle_out (GenParticlePtr p) |
Add outgoing particle. | |
void | remove_particle_in (GenParticlePtr p) |
Remove incoming particle. | |
void | remove_particle_out (GenParticlePtr p) |
Remove outgoing particle. | |
int | particles_in_size () const |
Number of incoming particles, HepMC2 compatiility. | |
int | particles_out_size () const |
Number of outgoing particles, HepMC2 compatiility. | |
const std::vector< GenParticlePtr > & | particles_in () |
Get list of incoming particles. | |
const std::vector< ConstGenParticlePtr > & | particles_in () const |
Get list of incoming particles (for const access) | |
const std::vector< GenParticlePtr > & | particles_out () |
Get list of outgoing particles. | |
const std::vector< ConstGenParticlePtr > & | particles_out () const |
Get list of outgoing particles (for const access) | |
const FourVector & | position () const |
Get vertex position. | |
bool | has_set_position () const |
Check if position of this vertex is set. | |
void | set_position (const FourVector &new_pos) |
Set vertex position. | |
bool | add_attribute (const std::string &name, std::shared_ptr< Attribute > att) |
Add event attribute to this vertex. | |
std::vector< std::string > | attribute_names () const |
Get list of names of attributes assigned to this particle. | |
void | remove_attribute (const std::string &name) |
Remove attribute. | |
template<class T> | |
std::shared_ptr< T > | attribute (const std::string &name) const |
Get attribute of type T. | |
std::string | attribute_as_string (const std::string &name) const |
Get attribute of any type as string. | |
Private Attributes | |
Fields | |
GenEvent * | m_event |
Parent event. | |
int | m_id |
Vertex id. | |
GenVertexData | m_data |
Vertex data. | |
std::vector< GenParticlePtr > | m_particles_in |
Incoming particle list. | |
std::vector< GenParticlePtr > | m_particles_out |
Outgoing particle list. | |
Friends | |
class | GenEvent |
GenVertex | ( | const FourVector & | position = FourVector::ZERO_VECTOR() | ) |
Default constructor.
Definition at line 22 of file GenVertex.cc.
GenVertex | ( | const GenVertexData & | data | ) |
Constructor based on vertex data.
Definition at line 29 of file GenVertex.cc.
bool add_attribute | ( | const std::string & | name, |
std::shared_ptr< Attribute > | att ) |
Add event attribute to this vertex.
This will overwrite existing attribute if an attribute with the same name is present. The attribute will be stored in the parent_event().
Definition at line 114 of file GenVertex.cc.
References GenEvent::add_attribute(), and parent_event().
void add_particle_in | ( | GenParticlePtr | p | ) |
Add incoming particle.
Definition at line 36 of file GenVertex.cc.
References m_event, m_particles_in, and particles_in().
void add_particle_out | ( | GenParticlePtr | p | ) |
Add outgoing particle.
Definition at line 52 of file GenVertex.cc.
References m_event, m_particles_out, and particles_out().
std::shared_ptr< T > attribute | ( | const std::string & | name | ) | const |
Get attribute of type T.
Definition at line 156 of file GenVertex.h.
References GenEvent::attribute(), id(), and parent_event().
std::string attribute_as_string | ( | const std::string & | name | ) | const |
Get attribute of any type as string.
Definition at line 124 of file GenVertex.cc.
References GenEvent::attribute_as_string(), and parent_event().
std::vector< std::string > attribute_names | ( | ) | const |
Get list of names of attributes assigned to this particle.
Definition at line 128 of file GenVertex.cc.
References GenEvent::attribute_names(), and parent_event().
|
inline |
|
inline |
Check if position of this vertex is set.
Definition at line 109 of file GenVertex.h.
References m_data.
|
inline |
|
inline |
Check if this vertex belongs to an event.
Definition at line 62 of file GenVertex.h.
References parent_event().
|
inline |
|
inline |
|
inline |
Get list of incoming particles.
Definition at line 93 of file GenVertex.h.
References m_particles_in.
const std::vector< ConstGenParticlePtr > & particles_in | ( | ) | const |
Get list of incoming particles (for const access)
Definition at line 82 of file GenVertex.cc.
References m_particles_in.
|
inline |
Number of incoming particles, HepMC2 compatiility.
Definition at line 87 of file GenVertex.h.
References m_particles_in.
|
inline |
Get list of outgoing particles.
Definition at line 97 of file GenVertex.h.
References m_particles_out.
const std::vector< ConstGenParticlePtr > & particles_out | ( | ) | const |
Get list of outgoing particles (for const access)
Definition at line 86 of file GenVertex.cc.
References m_particles_out.
|
inline |
Number of outgoing particles, HepMC2 compatiility.
Definition at line 89 of file GenVertex.h.
References m_particles_out.
const FourVector & position | ( | ) | const |
Get vertex position.
Returns the position of this vertex. If a position is not set on this vertex, the production vertices of ancestors are searched to find the inherited position. FourVector(0,0,0,0) is returned if no position information is found.
Definition at line 90 of file GenVertex.cc.
References GenEvent::attribute(), GenEvent::event_pos(), has_set_position(), m_data, m_particles_in, parent_event(), and FourVector::ZERO_VECTOR().
void remove_attribute | ( | const std::string & | name | ) |
Remove attribute.
Definition at line 120 of file GenVertex.cc.
References parent_event(), and GenEvent::remove_attribute().
void remove_particle_in | ( | GenParticlePtr | p | ) |
void remove_particle_out | ( | GenParticlePtr | p | ) |
void set_position | ( | const FourVector & | new_pos | ) |
|
inline |
|
inline |
|
friend |
Definition at line 31 of file GenVertex.h.
|
private |
Vertex data.
Definition at line 141 of file GenVertex.h.
|
private |
Parent event.
Definition at line 139 of file GenVertex.h.
|
private |
Vertex id.
Definition at line 140 of file GenVertex.h.
|
private |
Incoming particle list.
Definition at line 143 of file GenVertex.h.
|
private |
Outgoing particle list.
Definition at line 145 of file GenVertex.h.