AnnotatedMSRun::PairIterator< T1, T2 > Struct Template Reference

Iterator for pairs of spectra and peptide identifications. More...

#include <OpenMS/METADATA/AnnotatedMSRun.h>

Collaboration diagram for AnnotatedMSRun::PairIterator< T1, T2 >:

Public Types
using	iterator_category = std::forward_iterator_tag
using	difference_type = std::ptrdiff_t

Public Member Functions
	PairIterator (T1 ptr1, T2 ptr2)
	Constructor.
PairIterator &	operator++ ()
	Pre-increment operator.
PairIterator	operator++ (int)
	Post-increment operator.
auto	operator* ()
	Dereference operator.

Private Attributes
T1	m_ptr1
T2	m_ptr2

Friends
bool	operator== (const PairIterator &a, const PairIterator &b)
	Equality operator.
bool	operator!= (const PairIterator &a, const PairIterator &b)
	Inequality operator.

Detailed Description

template<typename T1, typename T2>
struct OpenMS::AnnotatedMSRun::PairIterator< T1, T2 >

Iterator for pairs of spectra and peptide identifications.

This iterator allows traversing the spectra and their associated peptide identifications together.

Member Typedef Documentation

difference_type

template<typename T1 , typename T2 >

using difference_type = std::ptrdiff_t

iterator_category

template<typename T1 , typename T2 >

using iterator_category = std::forward_iterator_tag

Constructor & Destructor Documentation

PairIterator()

template<typename T1 , typename T2 >

PairIterator ( T1  ptr1, T2  ptr2  )

inline

Constructor.

Parameters

[in]	ptr1	Iterator to the spectra
[in]	ptr2	Iterator to the peptide identifications

Member Function Documentation

operator*()

template<typename T1 , typename T2 >

auto operator* ( )

inline

Dereference operator.

Returns

A pair of references to the current spectrum and peptide identification

operator++() [1/2]

template<typename T1 , typename T2 >

PairIterator & operator++ ( )

inline

Pre-increment operator.

Returns

Reference to this iterator after incrementing

operator++() [2/2]

template<typename T1 , typename T2 >

PairIterator operator++ ( int  )

inline

Post-increment operator.

Returns

Copy of this iterator before incrementing

Friends And Related Symbol Documentation

operator!=

template<typename T1 , typename T2 >

bool operator!= ( const PairIterator< T1, T2 > &  a, const PairIterator< T1, T2 > &  b  )

friend

Inequality operator.

Parameters

[in]	a	First iterator
[in]	b	Second iterator

Returns

True if the iterators are not equal

operator==

template<typename T1 , typename T2 >

bool operator== ( const PairIterator< T1, T2 > &  a, const PairIterator< T1, T2 > &  b  )

friend

Equality operator.

Parameters

[in]	a	First iterator
[in]	b	Second iterator

Returns

True if the iterators are equal

Member Data Documentation

m_ptr1

template<typename T1 , typename T2 >

T1 m_ptr1

private

m_ptr2

template<typename T1 , typename T2 >

T2 m_ptr2

private