HepMC Reference Documentation HepMC

HepMC::GenEvent::particle_const_iterator Class Reference

const particle iterator More...

#include <GenEvent.h>

List of all members.

Public Member Functions
	particle_const_iterator (const std::map< int, HepMC::GenParticle * >::const_iterator &i)
	iterate over particles
	particle_const_iterator ()
	particle_const_iterator (const particle_const_iterator &i)
	copy constructor
virtual	~particle_const_iterator ()
particle_const_iterator &	operator= (const particle_const_iterator &i)
	make a copy
GenParticle *	operator * (void) const
	return a pointer to GenParticle
particle_const_iterator &	operator++ (void)
	Pre-fix increment.
particle_const_iterator	operator++ (int)
	Post-fix increment.
bool	operator== (const particle_const_iterator &a) const
	equality
bool	operator!= (const particle_const_iterator &a) const
	inequality
Protected Attributes
std::map< int, HepMC::GenParticle * >::const_iterator	m_map_iterator
	const iterator to the GenParticle map

---

Detailed Description

const particle iterator

HepMC::GenEvent::particle_const_iterator is used to iterate over all particles in the event.

Examples:

example_BuildEventFromScratch.cc, example_EventSelection.cc, and example_MyPythiaWithEventSelection.cc.

Definition at line 375 of file GenEvent.h.

---

Constructor & Destructor Documentation

HepMC::GenEvent::particle_const_iterator::particle_const_iterator

(

const std::map< int, HepMC::GenParticle * >::const_iterator &

i

)

[inline]

iterate over particles

Definition at line 380 of file GenEvent.h.

HepMC::GenEvent::particle_const_iterator::particle_const_iterator

(

)

[inline]

Definition at line 383 of file GenEvent.h.

HepMC::GenEvent::particle_const_iterator::particle_const_iterator

(

const particle_const_iterator &

i

)

[inline]

copy constructor

Definition at line 385 of file GenEvent.h.

virtual HepMC::GenEvent::particle_const_iterator::~particle_const_iterator

(

)

[inline, virtual]

Definition at line 387 of file GenEvent.h.

---

Member Function Documentation

particle_const_iterator& HepMC::GenEvent::particle_const_iterator::operator=

(

const particle_const_iterator &

i

)

[inline]

make a copy

Definition at line 389 of file GenEvent.h.

References m_map_iterator.

GenParticle* HepMC::GenEvent::particle_const_iterator::operator *

(

void

)

const [inline]

return a pointer to GenParticle

Definition at line 393 of file GenEvent.h.

References m_map_iterator.

particle_const_iterator& HepMC::GenEvent::particle_const_iterator::operator++

(

void

)

[inline]

Pre-fix increment.

Definition at line 396 of file GenEvent.h.

References m_map_iterator.

particle_const_iterator HepMC::GenEvent::particle_const_iterator::operator++

(

int

)

[inline]

Post-fix increment.

Definition at line 399 of file GenEvent.h.

bool HepMC::GenEvent::particle_const_iterator::operator==

(

const particle_const_iterator &

a

)

const [inline]

equality

Definition at line 402 of file GenEvent.h.

References m_map_iterator.

bool HepMC::GenEvent::particle_const_iterator::operator!=

(

const particle_const_iterator &

a

)

const [inline]

inequality

Definition at line 405 of file GenEvent.h.

References m_map_iterator.

---

Member Data Documentation

std::map<int,HepMC::GenParticle*>::const_iterator HepMC::GenEvent::particle_const_iterator::m_map_iterator [protected]

const iterator to the GenParticle map

Definition at line 409 of file GenEvent.h.

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

---

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

• GenEvent.h

---