HepMC Reference Documentation

HepMC

HepMC::GenEvent::vertex_iterator Class Reference

non-const vertex iterator More...

#include <GenEvent.h>

List of all members.

Public Member Functions

 vertex_iterator (const std::map< int, HepMC::GenVertex *, std::greater< int > >::iterator &i)
 constructor requiring vertex information
 vertex_iterator ()
 vertex_iterator (const vertex_iterator &i)
 copy constructor
virtual ~vertex_iterator ()
vertex_iteratoroperator= (const vertex_iterator &i)
 make a copy
 operator vertex_const_iterator () const
 const vertex iterator
GenVertexoperator * (void) const
 return a pointer to a GenVertex
vertex_iteratoroperator++ (void)
 Pre-fix increment.
vertex_iterator operator++ (int)
 Post-fix increment.
bool operator== (const vertex_iterator &a) const
 equality
bool operator!= (const vertex_iterator &a) const
 inequality

Protected Attributes

std::map< int, HepMC::GenVertex *,
std::greater< int > >::iterator 
m_map_iterator
 iterator to the vertex map


Detailed Description

non-const vertex iterator

HepMC::GenEvent::vertex_iterator is used to iterate over all vertices in the event.

Examples:

example_UsingIterators.cc, and testHepMCIteration.cc.in.

Definition at line 367 of file GenEvent.h.


Constructor & Destructor Documentation

HepMC::GenEvent::vertex_iterator::vertex_iterator ( const std::map< int, HepMC::GenVertex *, std::greater< int > >::iterator &  i  )  [inline]

constructor requiring vertex information

Definition at line 372 of file GenEvent.h.

HepMC::GenEvent::vertex_iterator::vertex_iterator (  )  [inline]

Definition at line 376 of file GenEvent.h.

HepMC::GenEvent::vertex_iterator::vertex_iterator ( const vertex_iterator i  )  [inline]

copy constructor

Definition at line 378 of file GenEvent.h.

virtual HepMC::GenEvent::vertex_iterator::~vertex_iterator (  )  [inline, virtual]

Definition at line 379 of file GenEvent.h.


Member Function Documentation

GenVertex* HepMC::GenEvent::vertex_iterator::operator * ( void   )  const [inline]

return a pointer to a GenVertex

Definition at line 389 of file GenEvent.h.

References m_map_iterator.

HepMC::GenEvent::vertex_iterator::operator vertex_const_iterator (  )  const [inline]

const vertex iterator

Definition at line 386 of file GenEvent.h.

References m_map_iterator, and HepMC::GenEvent::vertex_const_iterator.

bool HepMC::GenEvent::vertex_iterator::operator!= ( const vertex_iterator a  )  const [inline]

inequality

Definition at line 401 of file GenEvent.h.

References m_map_iterator.

vertex_iterator HepMC::GenEvent::vertex_iterator::operator++ ( int   )  [inline]

Post-fix increment.

Definition at line 395 of file GenEvent.h.

vertex_iterator& HepMC::GenEvent::vertex_iterator::operator++ ( void   )  [inline]

Pre-fix increment.

Definition at line 392 of file GenEvent.h.

References m_map_iterator.

vertex_iterator& HepMC::GenEvent::vertex_iterator::operator= ( const vertex_iterator i  )  [inline]

make a copy

Definition at line 381 of file GenEvent.h.

References m_map_iterator.

bool HepMC::GenEvent::vertex_iterator::operator== ( const vertex_iterator a  )  const [inline]

equality

Definition at line 398 of file GenEvent.h.

References m_map_iterator.


Member Data Documentation

std::map<int,HepMC::GenVertex*,std::greater<int> >::iterator HepMC::GenEvent::vertex_iterator::m_map_iterator [protected]

iterator to the vertex map

Definition at line 406 of file GenEvent.h.

Referenced by operator *(), operator vertex_const_iterator(), operator!=(), operator++(), operator=(), and operator==().


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