StiSortedHitIterator Class Reference

#include <StiSortedHitIterator.h>

List of all members.

Public Member Functions

 StiSortedHitIterator ()
 Default constructor used to create an iterator that points to no hit (e.g. to be returned by end()).
 StiSortedHitIterator (StiHitContainer *hitContainer, vector< StiDetector * >::iterator firstDet, vector< StiDetector * >::iterator lastDet)
 Constructor using a StiHitContainer.
 StiSortedHitIterator (const StiSortedHitIterator &iter)
 Copy Constructor.
const StiSortedHitIteratoroperator= (const StiSortedHitIterator &iter)
 Asignment operator.
 ~StiSortedHitIterator ()
 Destructor.
bool operator== (const StiSortedHitIterator &rhs)
 equality:
bool operator!= (const StiSortedHitIterator &rhs)
 inequlity
StiHitoperator* ()
StiSortedHitIteratoroperator++ ()
 prefix
StiSortedHitIterator operator++ (int)
 postfix


Detailed Description

A STL compliant forward iterator that traverse all the hit held by the hit container.

Author:
Claude A Pruneau (Wayne State University)

Definition at line 21 of file StiSortedHitIterator.h.


Member Function Documentation

bool StiSortedHitIterator::operator!= ( const StiSortedHitIterator rhs  )  [inline]

inequlity

Inequality Two iterators are not equal unless they point to the same hit.

Definition at line 97 of file StiSortedHitIterator.h.

StiHit & StiSortedHitIterator::operator* (  )  [inline]

Dereferencing operator Returns a reference to the hit pointed at by this iterator

Definition at line 104 of file StiSortedHitIterator.h.

StiSortedHitIterator StiSortedHitIterator::operator++ ( int   )  [inline]

postfix

Postfix Increment Operator The iterator is increment to point at the next hit in the sorted container. In the case where the prefix operator increments beyond the end of the container, the pointer to _currentHit is set to 0. This demarcates the end of the traversal.

Definition at line 179 of file StiSortedHitIterator.h.

StiSortedHitIterator & StiSortedHitIterator::operator++ (  )  [inline]

prefix

Prefix Increment Operator The iterator is incremented to point to the next hit in the sorted container. In the case where the prefix operator increments beyond the end of the container, the pointer to _currentHit is set to 0. This demarcates the end of the traversal.

Definition at line 114 of file StiSortedHitIterator.h.

bool StiSortedHitIterator::operator== ( const StiSortedHitIterator rhs  )  [inline]

equality:

Equality operator Two iterators are equal (return true) if they point to the same hit.

Definition at line 90 of file StiSortedHitIterator.h.


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

Generated on Sat May 26 04:28:20 2012 for StRoot by  doxygen 1.5.9