In This Package:

HepMC::GenVertex::edge_iterator Class Reference

iterate over the family of edges connected to m_vertex begins with parents (incoming particles) then children (outgoing) This is not a recursive iterator . More...

#include <GenVertex.h>

Collaboration diagram for HepMC::GenVertex::edge_iterator:

[legend]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
Private Attributes
const GenVertex *	m_vertex
IteratorRange	m_range
std::vector< HepMC::GenParticle * >::const_iterator	m_set_iter
bool	m_is_inparticle_iter
bool	m_is_past_end

---

Detailed Description

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 172 of file GenVertex.h.

---

Constructor & Destructor Documentation

HepMC::GenVertex::edge_iterator::edge_iterator

(

)

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

used to set limits on the iteration

HepMC::GenVertex::edge_iterator::edge_iterator

(

const edge_iterator &

p

)

copy

virtual HepMC::GenVertex::edge_iterator::~edge_iterator

(

)

[virtual]

---

Member Function Documentation

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

(

const edge_iterator &

p

)

make a copy

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

(

void

)

const

return a pointer to a particle

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

(

void

)

Pre-fix increment.

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

(

int

)

Post-fix increment.

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

(

const edge_iterator &

a

)

const [inline]

equality

Definition at line 426 of file GenVertex.h.

                                       { 
        return **this == *a; 
    }

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

(

const edge_iterator &

a

)

const [inline]

inequality

Definition at line 431 of file GenVertex.h.

                                       { 
        return !(**this == *a); 
    }

bool HepMC::GenVertex::edge_iterator::is_parent

(

)

const

true if parent of root vtx

bool HepMC::GenVertex::edge_iterator::is_child

(

)

const

true if child of root vtx

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

(

)

const [inline]

root vertex of this iteration

Definition at line 436 of file GenVertex.h.

                                                                      {
        return m_vertex;
    }

---

Member Data Documentation

const GenVertex* HepMC::GenVertex::edge_iterator::m_vertex [private]

Definition at line 200 of file GenVertex.h.

IteratorRange HepMC::GenVertex::edge_iterator::m_range [private]

Definition at line 201 of file GenVertex.h.

std::vector<HepMC::GenParticle*>::const_iterator HepMC::GenVertex::edge_iterator::m_set_iter [private]

Definition at line 202 of file GenVertex.h.

bool HepMC::GenVertex::edge_iterator::m_is_inparticle_iter [private]

Definition at line 203 of file GenVertex.h.

bool HepMC::GenVertex::edge_iterator::m_is_past_end [private]

Definition at line 204 of file GenVertex.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/external/HepMC/2.03.09/i686-slc5-gcc41-opt/include/HepMC/GenVertex.h

---