gamgee::FastqIterator Class Reference

Utility class to enable for-each style iteration in the FastqReader class. More...

#include <fastq_iterator.h>

Public Member Functions
	FastqIterator ()
	creates an empty iterator (used for the end() method) More...
	FastqIterator (std::istream *in)
	initializes a new iterator based on an input stream (e.g. fastq/a file, stdin, ...) More...
	FastqIterator (const FastqIterator &)=delete
	a FastqIterator should never be copied as the underlying stream can only be manipulated by one object. More...
	FastqIterator (FastqIterator &&)
	a FastqIterator move constructor guarantees all objects will have the same state. More...
bool	operator!= (const FastqIterator &rhs)
	inequality operator (needed by for-each loop) More...
Fastq &	operator* ()
	dereference operator (needed by for-each loop) More...
Fastq &	operator++ ()
	increment operator (needed by for-each loop) More...

Detailed Description

Utility class to enable for-each style iteration in the FastqReader class.

Constructor & Destructor Documentation

gamgee::FastqIterator::FastqIterator

(

)

creates an empty iterator (used for the end() method)

gamgee::FastqIterator::FastqIterator

(

std::istream *

in

)

initializes a new iterator based on an input stream (e.g. fastq/a file, stdin, ...)

Parameters

in	input stream

gamgee::FastqIterator::FastqIterator ( const FastqIterator &  )

delete

a FastqIterator should never be copied as the underlying stream can only be manipulated by one object.

gamgee::FastqIterator::FastqIterator

(

FastqIterator &&

original

)

a FastqIterator move constructor guarantees all objects will have the same state.

Member Function Documentation

bool gamgee::FastqIterator::operator!=

(

const FastqIterator &

rhs

)

inequality operator (needed by for-each loop)

Parameters

rhs	the other FastqIterator to compare to

Returns

whether or not the two iterators are the same (e.g. have the same input stream on the same status)

Fastq & gamgee::FastqIterator::operator*

(

)

dereference operator (needed by for-each loop)

Returns

a reference to a parsed Fastq object (current in the stream)

Fastq & gamgee::FastqIterator::operator++

(

)

increment operator (needed by for-each loop)

Returns

the next parsed Fastq object (next in the stream)

---

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

• gamgee/fastq_iterator.h
• gamgee/fastq_iterator.cpp