Forward iterator for an area of peaks in an experiment. More...
#include <OpenMS/KERNEL/AreaIterator.h>
 
  
 | Public Types | |
| typedef DoubleReal | CoordinateType | 
| typedef ValueT | PeakType | 
| typedef SpectrumIteratorT | SpectrumIteratorType | 
| typedef PeakIteratorT | PeakIteratorType | 
| Typedefs for STL compliance | |
| typedef ValueT | value_type | 
| The iterator's value type.  More... | |
| typedef ReferenceT | reference | 
| The reference type as returned by operator*()  More... | |
| typedef PointerT | pointer | 
| The pointer type as returned by operator->()  More... | |
| typedef unsigned int | difference_type | 
| The difference type.  More... | |
| Public Member Functions | |
| AreaIterator (SpectrumIteratorType first, SpectrumIteratorType begin, SpectrumIteratorType end, CoordinateType low_mz, CoordinateType high_mz) | |
| Constructor for the begin iterator.  More... | |
| AreaIterator () | |
| Default constructor (for the end iterator)  More... | |
| ~AreaIterator () | |
| Destructor.  More... | |
| AreaIterator (const AreaIterator &rhs) | |
| Copy constructor.  More... | |
| AreaIterator & | operator= (const AreaIterator &rhs) | 
| Assignment operator.  More... | |
| bool | operator== (const AreaIterator &rhs) const | 
| Test for equality.  More... | |
| bool | operator!= (const AreaIterator &rhs) const | 
| Test for inequality.  More... | |
| AreaIterator & | operator++ () | 
| Step forward by one (prefix operator)  More... | |
| AreaIterator | operator++ (int) | 
| Step forward by one (postfix operator)  More... | |
| reference | operator* () const | 
| Dereferencing of this pointer yields the underlying peak.  More... | |
| pointer | operator-> () const | 
| Dereferencing of this pointer yields the underlying peak.  More... | |
| CoordinateType | getRT () const | 
| returns the retention time of the current scan  More... | |
| PeakIndex | getPeakIndex () const | 
| returns the PeakIndex corresponding to the current iterator position  More... | |
| Private Member Functions | |
| void | nextScan_ () | 
| Private Attributes | |
| SpectrumIteratorType | first_ | 
| Iterator to the first scan of the map (needed to calculate the index)  More... | |
| SpectrumIteratorType | current_scan_ | 
| Iterator to the current spectrum.  More... | |
| SpectrumIteratorType | end_scan_ | 
| Past-the-end iterator of spectra.  More... | |
| PeakIteratorType | current_peak_ | 
| Iterator to the current peak.  More... | |
| PeakIteratorType | end_peak_ | 
| Past-the-end iterator of peaks in the current spectrum.  More... | |
| CoordinateType | low_mz_ | 
| low m/z boundary  More... | |
| CoordinateType | high_mz_ | 
| high m/z boundary  More... | |
| bool | is_end_ | 
| Flag that indicates that this iterator is the end iterator.  More... | |
Forward iterator for an area of peaks in an experiment.
This iterator allows us to move through the data structure in a linear manner i.e. we don't need to jump to the next spectrum manually.
| typedef DoubleReal CoordinateType | 
| typedef unsigned int difference_type | 
The difference type.
| typedef PeakIteratorT PeakIteratorType | 
| typedef ValueT PeakType | 
| typedef PointerT pointer | 
The pointer type as returned by operator->()
| typedef ReferenceT reference | 
The reference type as returned by operator*()
| typedef SpectrumIteratorT SpectrumIteratorType | 
| typedef ValueT value_type | 
The iterator's value type.
| 
 | inline | 
Constructor for the begin iterator.
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().
| 
 | inline | 
Default constructor (for the end iterator)
| 
 | inline | 
Destructor.
| 
 | inline | 
Copy constructor.
| 
 | inline | 
returns the PeakIndex corresponding to the current iterator position
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::first_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::is_end_.
| 
 | inline | 
returns the retention time of the current scan
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_scan_.
| 
 | inlineprivate | 
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::end_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::end_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::high_mz_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::is_end_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::low_mz_.
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::AreaIterator(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++().
| 
 | inline | 
Test for inequality.
| 
 | inline | 
Dereferencing of this pointer yields the underlying peak.
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_peak_.
| 
 | inline | 
Step forward by one (prefix operator)
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::end_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::is_end_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().
| 
 | inline | 
Step forward by one (postfix operator)
| 
 | inline | 
Dereferencing of this pointer yields the underlying peak.
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_peak_.
| 
 | inline | 
Assignment operator.
References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::end_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::end_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::first_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::high_mz_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::is_end_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::low_mz_.
| 
 | inline | 
| 
 | private | 
Iterator to the current peak.
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator*(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator->(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator==().
| 
 | private | 
Iterator to the current spectrum.
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getRT(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=().
| 
 | private | 
Past-the-end iterator of peaks in the current spectrum.
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=().
| 
 | private | 
Past-the-end iterator of spectra.
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=().
| 
 | private | 
Iterator to the first scan of the map (needed to calculate the index)
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=().
| 
 | private | 
| 
 | private | 
Flag that indicates that this iterator is the end iterator.
Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator==().
| 
 | private | 
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:38 using doxygen 1.8.5 |