HepMC Reference Documentation HepMC

HepMC::GenVertex::edge_iterator Class Reference

edge iterator More...

#include <GenVertex.h>

List of all members.

Public Member Functions
	edge_iterator ()
	edge_iterator (const GenVertex &vtx, IteratorRange range=family)
	used to set limits on the iteration
	edge_iterator (const edge_iterator &p)
	copy
virtual	~edge_iterator ()
edge_iterator &	operator= (const edge_iterator &p)
	make a copy
GenParticle *	operator * (void) const
	return a pointer to a particle
edge_iterator &	operator++ (void)
	Pre-fix increment.
edge_iterator	operator++ (int)
	Post-fix increment.
bool	operator== (const edge_iterator &a) const
	equality
bool	operator!= (const edge_iterator &a) const
	inequality
bool	is_parent () const
	true if parent of root vtx
bool	is_child () const
	true if child of root vtx
const GenVertex *	vertex_root () const
	root vertex of this iteration

---

Detailed Description

edge iterator

iterate over the family of edges connected to m_vertex begins with parents (incoming particles) then children (outgoing) This is not a recursive iterator ... it is a building block for the public iterators and is intended for internal use only. The acceptable Iterator Ranges are: family, parents, children

Definition at line 171 of file GenVertex.h.

---

Constructor & Destructor Documentation

HepMC::GenVertex::edge_iterator::edge_iterator

(

)

Definition at line 451 of file GenVertex.cc.

HepMC::GenVertex::edge_iterator::edge_iterator	(	const GenVertex &	vtx,
		IteratorRange	range = family
	)

used to set limits on the iteration

Definition at line 455 of file GenVertex.cc.

References HepMC::ancestors, HepMC::children, HepMC::descendants, HepMC::family, HepMC::GenVertex::m_particles_in, HepMC::GenVertex::m_particles_out, and HepMC::parents.

HepMC::GenVertex::edge_iterator::edge_iterator

(

const edge_iterator &

p

)

copy

Definition at line 506 of file GenVertex.cc.

References p.

HepMC::GenVertex::edge_iterator::~edge_iterator

(

)

[virtual]

Definition at line 510 of file GenVertex.cc.

---

Member Function Documentation

GenVertex::edge_iterator & HepMC::GenVertex::edge_iterator::operator=

(

const edge_iterator &

p

)

make a copy

Definition at line 512 of file GenVertex.cc.

References p.

GenParticle * HepMC::GenVertex::edge_iterator::operator *

(

void

)

const

return a pointer to a particle

Definition at line 522 of file GenVertex.cc.

GenVertex::edge_iterator & HepMC::GenVertex::edge_iterator::operator++

(

void

)

Pre-fix increment.

Definition at line 527 of file GenVertex.cc.

References HepMC::family, HepMC::GenVertex::m_particles_in, HepMC::GenVertex::m_particles_out, and HepMC::parents.

GenVertex::edge_iterator HepMC::GenVertex::edge_iterator::operator++

(

int

)

Post-fix increment.

Definition at line 555 of file GenVertex.cc.

bool HepMC::GenVertex::edge_iterator::operator==

(

const edge_iterator &

a

)

const [inline]

equality

Definition at line 425 of file GenVertex.h.

bool HepMC::GenVertex::edge_iterator::operator!=

(

const edge_iterator &

a

)

const [inline]

inequality

Definition at line 430 of file GenVertex.h.

bool HepMC::GenVertex::edge_iterator::is_parent

(

)

const

true if parent of root vtx

Definition at line 562 of file GenVertex.cc.

Referenced by HepMC::GenVertex::particle_iterator::advance_to_first_(), and HepMC::GenVertex::vertex_iterator::follow_edge_().

bool HepMC::GenVertex::edge_iterator::is_child

(

)

const

true if child of root vtx

Definition at line 567 of file GenVertex.cc.

const GenVertex * HepMC::GenVertex::edge_iterator::vertex_root

(

)

const [inline]

root vertex of this iteration

Definition at line 435 of file GenVertex.h.

---

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

• GenVertex.h
• GenVertex.cc

---