Stores vertex-related information. More...

#include <GenVertex.h>

Inheritance diagram for HepMC3::GenVertex:

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.

Friends
class	GenEvent

Detailed Description

Stores vertex-related information.

Definition at line 29 of file GenVertex.h.

Constructor & Destructor Documentation

◆ GenVertex() [1/2]

HepMC3::GenVertex::GenVertex ( const FourVector & position = FourVector::ZERO_VECTOR() )

Default constructor.

Definition at line 351 of file marley_hepmc3.cc.

                                         :
    m_event(nullptr),
    m_id(0) {
    m_data.status   = 0;
    m_data.position = pos;
}

◆ GenVertex() [2/2]

HepMC3::GenVertex::GenVertex ( const GenVertexData & data )

Constructor based on vertex data.

Definition at line 358 of file marley_hepmc3.cc.

                                            :
    m_event(nullptr),
    m_id(0),
    m_data(dat) {
}

Member Function Documentation

◆ add_attribute()

bool HepMC3::GenVertex::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().

Returns: false if there is no parent_event();

Definition at line 443 of file marley_hepmc3.cc.

                                                                                 {
    if ( !parent_event() ) return false;
    parent_event()->add_attribute(name, att, id());
    return true;
}

References HepMC3::GenEvent::add_attribute(), and parent_event().

◆ add_particle_in()

void HepMC3::GenVertex::add_particle_in ( GenParticlePtr p )

Add incoming particle.

Definition at line 365 of file marley_hepmc3.cc.

                                                {
    if (!p) return;
 
    // Avoid duplicates
    if (std::find(particles_in().begin(), particles_in().end(), p) != particles_in().end()) return;
 
    m_particles_in.emplace_back(p);
 
    if ( p->end_vertex() ) p->end_vertex()->remove_particle_in(p);
 
    p->m_end_vertex = shared_from_this();
 
    if (m_event) m_event->add_particle(p);
}

References particles_in().

◆ add_particle_out()

void HepMC3::GenVertex::add_particle_out ( GenParticlePtr p )

Add outgoing particle.

Definition at line 381 of file marley_hepmc3.cc.

                                                 {
    if (!p) return;
 
    // Avoid duplicates
    if (std::find(particles_out().begin(), particles_out().end(), p) != particles_out().end()) return;
 
    m_particles_out.emplace_back(p);
 
    if ( p->production_vertex() ) p->production_vertex()->remove_particle_out(p);
 
    p->m_production_vertex = shared_from_this();
 
    if (m_event) m_event->add_particle(p);
}

References particles_out().

◆ attribute()

template<class T>

std::shared_ptr< T > HepMC3::GenVertex::attribute ( const std::string & name ) const

Get attribute of type T.

Definition at line 156 of file GenVertex.h.

                                                                                   {
    return parent_event()?
           parent_event()->attribute<T>(name, id()): std::shared_ptr<T>();
}

References HepMC3::GenEvent::attribute(), id(), and parent_event().

◆ attribute_as_string()

std::string HepMC3::GenVertex::attribute_as_string ( const std::string & name ) const

Get attribute of any type as string.

Definition at line 453 of file marley_hepmc3.cc.

                                                                    {
    return parent_event() ? parent_event()->attribute_as_string(name, id()) : std::string();
}

References HepMC3::GenEvent::attribute_as_string(), and parent_event().

◆ attribute_names()

std::vector< std::string > HepMC3::GenVertex::attribute_names ( ) const

Get list of names of attributes assigned to this particle.

Definition at line 457 of file marley_hepmc3.cc.

                                                      {
    if ( parent_event() ) return parent_event()->attribute_names(id());
 
    return {};
}

References HepMC3::GenEvent::attribute_names(), and parent_event().

◆ data()

const GenVertexData & HepMC3::GenVertex::data ( ) const

inline

Get vertex data.

Definition at line 75 of file GenVertex.h.

75{ return m_data; }

◆ has_set_position()

bool HepMC3::GenVertex::has_set_position ( ) const

inline

Check if position of this vertex is set.

Definition at line 109 of file GenVertex.h.

109{ return !(m_data.position.is_zero()); }

Referenced by position().

◆ id()

int HepMC3::GenVertex::id ( ) const

inline

Get the vertex unique identifier

Note: This is not the same as id() in HepMC v2, which is now status()

Definition at line 67 of file GenVertex.h.

67{ return m_id; }

Referenced by attribute().

◆ in_event()

bool HepMC3::GenVertex::in_event ( ) const

inline

Check if this vertex belongs to an event.

Definition at line 62 of file GenVertex.h.

62{ return parent_event() != nullptr; }

References parent_event().

◆ parent_event() [1/2]

GenEvent * HepMC3::GenVertex::parent_event ( )

inline

Get parent event.

Definition at line 56 of file GenVertex.h.

56{ return m_event; }

Referenced by add_attribute(), attribute(), attribute_as_string(), attribute_names(), in_event(), position(), and remove_attribute().

◆ parent_event() [2/2]

const GenEvent * HepMC3::GenVertex::parent_event ( ) const

inline

Get parent event.

Definition at line 59 of file GenVertex.h.

59{ return m_event; }

◆ particles_in() [1/2]

const std::vector< GenParticlePtr > & HepMC3::GenVertex::particles_in ( )

inline

Get list of incoming particles.

Definition at line 93 of file GenVertex.h.

93{ return m_particles_in; }

Referenced by add_particle_in().

◆ particles_in() [2/2]

const std::vector< ConstGenParticlePtr > & HepMC3::GenVertex::particles_in ( ) const

Get list of incoming particles (for const access)

Definition at line 411 of file marley_hepmc3.cc.

                                                                   {
    return *(reinterpret_cast<const std::vector<ConstGenParticlePtr>*>(&m_particles_in));
}

◆ particles_in_size()

int HepMC3::GenVertex::particles_in_size ( ) const

inline

Number of incoming particles, HepMC2 compatiility.

Definition at line 87 of file GenVertex.h.

87{ return m_particles_in.size(); }

◆ particles_out() [1/2]

const std::vector< GenParticlePtr > & HepMC3::GenVertex::particles_out ( )

inline

Get list of outgoing particles.

Definition at line 97 of file GenVertex.h.

97{ return m_particles_out; }

Referenced by add_particle_out().

◆ particles_out() [2/2]

const std::vector< ConstGenParticlePtr > & HepMC3::GenVertex::particles_out ( ) const

Get list of outgoing particles (for const access)

Definition at line 415 of file marley_hepmc3.cc.

                                                                    {
    return *(reinterpret_cast<const std::vector<ConstGenParticlePtr>*>(&m_particles_out));
}

◆ particles_out_size()

int HepMC3::GenVertex::particles_out_size ( ) const

inline

Number of outgoing particles, HepMC2 compatiility.

Definition at line 89 of file GenVertex.h.

89{ return m_particles_out.size(); }

◆ position()

const FourVector & HepMC3::GenVertex::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 419 of file marley_hepmc3.cc.

                                            {
    if ( has_set_position() ) return m_data.position;
 
    // No position information - look at event and/or search ancestors
    if ( parent_event() )
    {
        std::shared_ptr<IntAttribute> cycles = parent_event()->attribute<IntAttribute>("cycles");
        //This could be a recussive call.  Try to prevent it.
        if (!cycles || cycles->value() == 0)
        {
            for (const auto& p: m_particles_in) {
                ConstGenVertexPtr v = p->production_vertex();
                if (v) return v->position();
            }
        }
        return parent_event()->event_pos();
    }
    return FourVector::ZERO_VECTOR();
}

References HepMC3::GenEvent::attribute(), HepMC3::GenEvent::event_pos(), has_set_position(), parent_event(), and HepMC3::FourVector::ZERO_VECTOR().

◆ remove_attribute()

void HepMC3::GenVertex::remove_attribute ( const std::string & name )

Remove attribute.

Definition at line 449 of file marley_hepmc3.cc.

                                                      {
    if ( parent_event() ) parent_event()->remove_attribute(name, id());
}

References parent_event(), and HepMC3::GenEvent::remove_attribute().

◆ remove_particle_in()

void HepMC3::GenVertex::remove_particle_in ( GenParticlePtr p )

Remove incoming particle.

Definition at line 396 of file marley_hepmc3.cc.

                                                   {
    if (!p) return;
    if (std::find(m_particles_in.begin(), m_particles_in.end(), p) == m_particles_in.end()) return;
    p->m_end_vertex.reset();
    m_particles_in.erase(std::remove(m_particles_in.begin(), m_particles_in.end(), p), m_particles_in.end());
}

◆ remove_particle_out()

void HepMC3::GenVertex::remove_particle_out ( GenParticlePtr p )

Remove outgoing particle.

Definition at line 404 of file marley_hepmc3.cc.

                                                    {
    if (!p) return;
    if (std::find(m_particles_out.begin(), m_particles_out.end(), p) == m_particles_out.end()) return;
    p->m_production_vertex.reset();
    m_particles_out.erase(std::remove(m_particles_out.begin(), m_particles_out.end(), p), m_particles_out.end());
}

◆ set_position()

void HepMC3::GenVertex::set_position ( const FourVector & new_pos )

Set vertex position.

Definition at line 439 of file marley_hepmc3.cc.

                                                      {
    m_data.position = new_pos;
}

◆ set_status()

void HepMC3::GenVertex::set_status ( int stat )

inline

Set vertex status code.

Definition at line 72 of file GenVertex.h.

72{ m_data.status = stat; }

◆ status()

int HepMC3::GenVertex::status ( ) const

inline

Get vertex status code.

Definition at line 70 of file GenVertex.h.

70{ return m_data.status; }

Friends And Related Symbol Documentation

◆ GenEvent

friend class GenEvent

friend

Definition at line 31 of file GenVertex.h.

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

/home/sjg/Desktop/marley/include/builtin/HepMC3/GenVertex.h
/home/sjg/Desktop/marley/src/marley_hepmc3.cc

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GenVertex() [1/2]

◆ GenVertex() [2/2]

Member Function Documentation

◆ add_attribute()

◆ add_particle_in()

◆ add_particle_out()

◆ attribute()

◆ attribute_as_string()

◆ attribute_names()

◆ data()

◆ has_set_position()

◆ id()

◆ in_event()

◆ parent_event() [1/2]

◆ parent_event() [2/2]

◆ particles_in() [1/2]

◆ particles_in() [2/2]

◆ particles_in_size()

◆ particles_out() [1/2]

◆ particles_out() [2/2]

◆ particles_out_size()

◆ position()

◆ remove_attribute()

◆ remove_particle_in()

◆ remove_particle_out()

◆ set_position()

◆ set_status()

◆ status()

Friends And Related Symbol Documentation

◆ GenEvent