gamgee::ReferenceIterator Class Reference

Utility class to access reference bases in a FastA-formatted reference genome. More...

#include <reference_iterator.h>

Public Member Functions
	ReferenceIterator (const std::string &filename)
const char	ref_base (const std::string &chromosome, const int one_based_location)
	return the reference base character at the desired location More...

Detailed Description

Utility class to access reference bases in a FastA-formatted reference genome.

the chromosomes in this reference must be accessed in order, or an exception will be thrown

Constructor & Destructor Documentation

gamgee::ReferenceIterator::ReferenceIterator ( const std::string &  filename )

inline

Member Function Documentation

const char gamgee::ReferenceIterator::ref_base	(	const std::string &	chromosome,
		const int	one_based_location
	)

return the reference base character at the desired location

Parameters

chromosome	the chromosome of the desired base
one_based_location	the one-based genomic location of the base

---

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

• gamgee/reference_iterator.h
• gamgee/reference_iterator.cpp