kaori::FastqReader Class Reference

Stream reads from a FASTQ file. More...

#include <FastqReader.hpp>

Public Member Functions
	FastqReader (byteme::Reader *p)
bool	operator() ()
const std::vector< char > &	get_sequence () const
const std::vector< char > &	get_name () const

Detailed Description

Stream reads from a FASTQ file.

Pretty much what it says on the tin. Multi-line sequence and quality strings are supported. The name of each read is only considered up to the first whitespace.

Constructor & Destructor Documentation

FastqReader()

kaori::FastqReader::FastqReader ( byteme::Reader *  p )

inline

Parameters

p	Any byteme::Reader instance that defines a text stream.

Member Function Documentation

get_name()

const std::vector< char > & kaori::FastqReader::get_name ( ) const

inline

Returns

Vector containing the name for the current read. Note that the name is considered to end at the first whitespace on the line.

get_sequence()

const std::vector< char > & kaori::FastqReader::get_sequence ( ) const

inline

Returns

Vector containing the sequence for the current read.

operator()()

bool kaori::FastqReader::operator() ( )

inline

Extract details for the next read in the file.

Returns

Whether or not a record was successfully extracted. If true, get_sequence() and get_name() may be used. If false, this indicates that we reached the end of the file.

---

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

• kaori/FastqReader.hpp