pwiz::msdata::SpectrumIterator Class Reference

SpectrumIterator provides convenient iteration through a set of scans in a SpectrumList. More...

#include <SpectrumIterator.hpp>

List of all members.

Classes
struct	Config
	SpectrumIterator configuration – note that constructors allow automatic conversion from IntegerSet or Sieve to Config. More...
class	Sieve
	interface for filtering based on ScanInfo More...

Public Types
standard iterator typedefs
typedef std::input_iterator_tag	iterator_category
typedef Spectrum	value_type
typedef int	difference_type
typedef value_type *	pointer
typedef value_type &	reference

Public Member Functions
	SpectrumIterator ()
	special default object for marking past-the-end
	SpectrumIterator (const SpectrumList &spectrumList, const Config &config=Config())
	constructor for normal initialization of the iterator
	SpectrumIterator (const MSData &msd, const Config &config=Config())
	constructor using MSData object
	SpectrumIterator (const SpectrumIterator &)
	copy constructor
input iterator interface
SpectrumIterator &	operator++ ()
const Spectrum &	operator* () const
const Spectrum *	operator-> () const
bool	operator== (const SpectrumIterator &that) const
bool	operator!= (const SpectrumIterator &that) const

Private Member Functions
SpectrumIterator &	operator= (const SpectrumIterator &)
	no copying
SpectrumIterator	operator++ (int)
	don't do this – avoid temporary copy

Private Attributes
boost::shared_ptr< Impl >	impl_

---

Detailed Description

SpectrumIterator provides convenient iteration through a set of scans in a SpectrumList.

Its behavior is similar to istream_iterator. In particular:

• the default constructed SpectrumIterator() is a past-the-end marker
• references to the current Spectrum are invalidated by preincrement

Because SpectrumIterator holds a copy of the current Spectrum internally, copy assignment and postincrement have been disabled.

Iteration may be customized in a number of ways:

• clients may specify an IntegerSet of scan numbers through which to iterate.
• clients may specify a Sieve to filter based on Spectrum fields.
• clients may specify whether binary data is retrieved in the Spectrum object (default==true)

For usage examples, see SpectrumIteratorTest.cpp

Definition at line 57 of file SpectrumIterator.hpp.

---

Member Typedef Documentation

typedef std::input_iterator_tag pwiz::msdata::SpectrumIterator::iterator_category

Definition at line 115 of file SpectrumIterator.hpp.

typedef Spectrum pwiz::msdata::SpectrumIterator::value_type

Definition at line 116 of file SpectrumIterator.hpp.

typedef int pwiz::msdata::SpectrumIterator::difference_type

Definition at line 117 of file SpectrumIterator.hpp.

typedef value_type* pwiz::msdata::SpectrumIterator::pointer

Definition at line 118 of file SpectrumIterator.hpp.

typedef value_type& pwiz::msdata::SpectrumIterator::reference

Definition at line 119 of file SpectrumIterator.hpp.

---

Constructor & Destructor Documentation

pwiz::msdata::SpectrumIterator::SpectrumIterator

(

)

special default object for marking past-the-end

pwiz::msdata::SpectrumIterator::SpectrumIterator	(	const SpectrumList &	spectrumList,
		const Config &	config = Config()
	)

constructor for normal initialization of the iterator

pwiz::msdata::SpectrumIterator::SpectrumIterator	(	const MSData &	msd,
		const Config &	config = Config()
	)

constructor using MSData object

pwiz::msdata::SpectrumIterator::SpectrumIterator

(

const SpectrumIterator &

)

copy constructor

---

Member Function Documentation

SpectrumIterator& pwiz::msdata::SpectrumIterator::operator++

(

)

const Spectrum& pwiz::msdata::SpectrumIterator::operator*

(

)

const

const Spectrum* pwiz::msdata::SpectrumIterator::operator->

(

)

const

bool pwiz::msdata::SpectrumIterator::operator==

(

const SpectrumIterator &

that

)

const

bool pwiz::msdata::SpectrumIterator::operator!=

(

const SpectrumIterator &

that

)

const

SpectrumIterator& pwiz::msdata::SpectrumIterator::operator= ( const SpectrumIterator &  )

private

no copying

SpectrumIterator pwiz::msdata::SpectrumIterator::operator++ ( int  )

private

don't do this – avoid temporary copy

---

Member Data Documentation

boost::shared_ptr<Impl> pwiz::msdata::SpectrumIterator::impl_

private

Definition at line 124 of file SpectrumIterator.hpp.

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/SpectrumIterator.hpp