gsa-engineering/gamgee/fastq__reader_8h_source.html

 #ifndef __foghorn__fastq_reader__

 #define __foghorn__fastq_reader__


 #include "fastq_iterator.h"


 #include <string>

 #include <iostream>

 #include <fstream>


 namespace gamgee {


 class FastqReader {

  public:


   FastqReader(const std::string& filename);


   FastqReader(std::istream* const input);


   ~FastqReader();


   FastqReader(FastqReader&&);


   FastqReader(const FastqReader&) = delete;


   FastqIterator begin();


   FastqIterator end();


 private:

   std::istream* m_input_stream;

   std::ifstream m_file_stream;

 };


 }  // end of namespace


 #endif /* defined(__foghorn__fastq_iterator__) */

gamgee::FastqReader
Utility class to read many Fastq records from a stream (e.g. Fastq file, stdin, ...) in a for-each loop in a for-each loop.
Definition: fastq_reader.h:34

gamgee::FastqReader::FastqReader
FastqReader(const std::string &filename)
reades through all records in a file (fasta or fastq) parsing them into Fastq objects ...
Definition: fastq_reader.cpp:14

gamgee::FastqReader::begin
FastqIterator begin()
creates a FastqIterator pointing at the start of the input stream (needed by for-each loop) ...
Definition: fastq_reader.cpp:29

gamgee::FastqReader::end
FastqIterator end()
creates a FastqIterator with a nullified input stream (needed by for-each loop)
Definition: fastq_reader.cpp:33

gamgee::FastqIterator
Utility class to enable for-each style iteration in the FastqReader class.
Definition: fastq_iterator.h:12

fastq_iterator.h

gamgee::FastqReader::~FastqReader
~FastqReader()
closes the file stream if there is one (in case we are reading a fasta/fastq file) ...
Definition: fastq_reader.cpp:21