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_iteratoroperator= (const edge_iterator &p)
 make a copy
GenParticleoperator * (void) const
 return a pointer to a particle
edge_iteratoroperator++ (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 GenVertexvertex_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 178 of file GenVertex.h.


Constructor & Destructor Documentation

HepMC::GenVertex::edge_iterator::edge_iterator (  ) 

Definition at line 462 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 466 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 517 of file GenVertex.cc.

References p.

HepMC::GenVertex::edge_iterator::~edge_iterator (  )  [virtual]

Definition at line 521 of file GenVertex.cc.


Member Function Documentation

bool HepMC::GenVertex::edge_iterator::is_child (  )  const

true if child of root vtx

Definition at line 590 of file GenVertex.cc.

bool HepMC::GenVertex::edge_iterator::is_parent (  )  const

true if parent of root vtx

Definition at line 585 of file GenVertex.cc.

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

GenParticle * HepMC::GenVertex::edge_iterator::operator * ( void   )  const

return a pointer to a particle

Definition at line 533 of file GenVertex.cc.

bool HepMC::GenVertex::edge_iterator::operator!= ( const edge_iterator a  )  const [inline]

inequality

Definition at line 451 of file GenVertex.h.

GenVertex::edge_iterator HepMC::GenVertex::edge_iterator::operator++ ( int   ) 

Post-fix increment.

Definition at line 578 of file GenVertex.cc.

GenVertex::edge_iterator & HepMC::GenVertex::edge_iterator::operator++ ( void   ) 

Pre-fix increment.

Definition at line 538 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= ( const edge_iterator p  ) 

make a copy

Definition at line 523 of file GenVertex.cc.

References p.

bool HepMC::GenVertex::edge_iterator::operator== ( const edge_iterator a  )  const [inline]

equality

Definition at line 446 of file GenVertex.h.

const GenVertex * HepMC::GenVertex::edge_iterator::vertex_root (  )  const [inline]

root vertex of this iteration

Definition at line 456 of file GenVertex.h.


The documentation for this class was generated from the following files:
Generated on Thu Jan 7 13:10:18 2010 for HepMC by  doxygen 1.4.7