List of all members | Public Member Functions | Private Member Functions | Private Attributes
utl::ShowerParticleIterator Class Reference

Iterator to retrieve particles from utl::VShowerParticlList. More...

#include "utl/ShowerParticleIterator.h"

Inheritance diagram for utl::ShowerParticleIterator:
Inheritance graph
[legend]

Public Member Functions

bool operator!= (const ShowerParticleIterator &it) const
 
const Particleoperator* () const
 
ShowerParticleIteratoroperator++ ()
 Prefix increment. More...
 
ShowerParticleIterator operator++ (int)
 Postfix increment. More...
 
const Particleoperator-> () const
 
bool operator== (const ShowerParticleIterator &it) const
 
 ShowerParticleIterator (VShowerFileParticleIterator *const fileIt=nullptr, const CoordinateSystemPtr &cs=CoordinateSystemPtr())
 

Private Member Functions

void CheckReference () const
 

Private Attributes

ParticlefCurrentParticle = nullptr
 
CoordinateSystemPtr fGroundCS
 The reference frame for particle reading. More...
 
VShowerFileParticleIteratorfParticles = nullptr
 

Detailed Description

Iterator to retrieve particles from utl::VShowerParticlList.

This class implements an input iterator to iterate over all particles in a utl::VShowerParticleList. The code doing the real work is in the implementation of the utl::VShowerParticleList interface.

Note
Since this is an input iterator, it only provides read access to the contents of the associated ShowerParticleList.
Author
Lukas Nellen
Date
4-Apr-2003

Definition at line 32 of file ShowerParticleIterator.h.

Constructor & Destructor Documentation

utl::ShowerParticleIterator::ShowerParticleIterator ( VShowerFileParticleIterator *const  fileIt = nullptr,
const CoordinateSystemPtr cs = CoordinateSystemPtr() 
)
explicit

Member Function Documentation

void utl::ShowerParticleIterator::CheckReference ( ) const
private

Definition at line 33 of file ShowerParticleIterator.cc.

References fCurrentParticle.

Referenced by operator*(), and operator->().

bool utl::ShowerParticleIterator::operator!= ( const ShowerParticleIterator it) const
inline

Definition at line 48 of file ShowerParticleIterator.h.

References operator==().

const Particle & utl::ShowerParticleIterator::operator* ( ) const

Definition at line 42 of file ShowerParticleIterator.cc.

References CheckReference(), and fCurrentParticle.

ShowerParticleIterator & utl::ShowerParticleIterator::operator++ ( )
ShowerParticleIterator utl::ShowerParticleIterator::operator++ ( int  )

Postfix increment.

Definition at line 73 of file ShowerParticleIterator.cc.

const Particle * utl::ShowerParticleIterator::operator-> ( ) const

Definition at line 51 of file ShowerParticleIterator.cc.

References CheckReference(), and fCurrentParticle.

bool utl::ShowerParticleIterator::operator== ( const ShowerParticleIterator it) const

Definition at line 82 of file ShowerParticleIterator.cc.

References fCurrentParticle, and fParticles.

Referenced by operator!=().

Member Data Documentation

Particle* utl::ShowerParticleIterator::fCurrentParticle = nullptr
private
CoordinateSystemPtr utl::ShowerParticleIterator::fGroundCS
private

The reference frame for particle reading.

Definition at line 56 of file ShowerParticleIterator.h.

Referenced by operator++(), and ShowerParticleIterator().

VShowerFileParticleIterator* utl::ShowerParticleIterator::fParticles = nullptr
private

Definition at line 54 of file ShowerParticleIterator.h.

Referenced by operator++(), operator==(), and ShowerParticleIterator().


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

, generated on Tue Sep 26 2023.