Utility class to enable for-each style iteration in the FastqReader class.
More...
#include <fastq_iterator.h>
Utility class to enable for-each style iteration in the FastqReader class.
| gamgee::FastqIterator::FastqIterator |
( |
| ) |
|
creates an empty iterator (used for the end() method)
| gamgee::FastqIterator::FastqIterator |
( |
std::shared_ptr< std::istream > & |
in | ) |
|
|
explicit |
initializes a new iterator based on an input stream (e.g. fastq/a file, stdin, ...)
- Parameters
-
a FastqIterator should never be copied as the underlying stream can only be manipulated by one object.
a FastqIterator move constructor guarantees all objects will have the same state.
| bool gamgee::FastqIterator::operator!= |
( |
const FastqIterator & |
rhs | ) |
const |
inequality operator (needed by for-each loop)
- Parameters
-
- 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)
| bool gamgee::FastqIterator::operator== |
( |
const FastqIterator & |
rhs | ) |
const |
equality operator
- Parameters
-
- Returns
- whether or not the two iterators are the same (e.g. have the same input stream on the same status)
The documentation for this class was generated from the following files:
1.8.8