bpp::ChromosomeMafIterator Class Reference

Filter maf blocks to keep only the block corresponding to one chromosome (of a reference sequence). More...

#include <Bpp/Seq/Io/MafIterator.h>

Inheritance diagram for bpp::ChromosomeMafIterator:

[legend]

Collaboration diagram for bpp::ChromosomeMafIterator:

[legend]

List of all members.

Public Member Functions
	ChromosomeMafIterator (MafIterator *iterator, const std::string &reference, const std::string &chr)
MafBlock *	nextBlock () throw (Exception)
	Get the next available alignment block.
void	setLogStream (OutputStream *logstream)
bool	verbose () const
void	verbose (bool yn)
Protected Attributes
MafIterator *	iterator_
OutputStream *	logstream_
bool	verbose_
Private Member Functions
	ChromosomeMafIterator (const ChromosomeMafIterator &iterator)
ChromosomeMafIterator &	operator= (const ChromosomeMafIterator &iterator)
Private Attributes
std::string	ref_
std::string	chr_
MafBlock *	currentBlock_

---

Detailed Description

Filter maf blocks to keep only the block corresponding to one chromosome (of a reference sequence).

Definition at line 437 of file MafIterator.h.

---

Constructor & Destructor Documentation

bpp::ChromosomeMafIterator::ChromosomeMafIterator	(	MafIterator *	iterator,
		const std::string &	reference,
		const std::string &	chr
	)			[inline]

Parameters:

	iterator	The input iterator.
	reference	The reference species name.
	chr	the chromosome name to filter.

Definition at line 451 of file MafIterator.h.

bpp::ChromosomeMafIterator::ChromosomeMafIterator

(

const ChromosomeMafIterator &

iterator

)

[inline, private]

Definition at line 459 of file MafIterator.h.

---

Member Function Documentation

MafBlock * ChromosomeMafIterator::nextBlock

(

)

throw (Exception) [virtual]

Get the next available alignment block.

Returns:

A maf alignment block, or a null pointer if no more block is available.

Implements bpp::MafIterator.

Definition at line 130 of file MafIterator.cpp.

References chr_, currentBlock_, bpp::MafSequence::getChromosome(), bpp::MafBlock::getNumberOfSequences(), bpp::MafBlock::getSequence(), bpp::MafSequence::getSpecies(), bpp::AbstractFilterMafIterator::iterator_, bpp::AbstractFilterMafIterator::logstream_, bpp::MafIterator::nextBlock(), and ref_.

ChromosomeMafIterator& bpp::ChromosomeMafIterator::operator=

(

const ChromosomeMafIterator &

iterator

)

[inline, private]

Definition at line 466 of file MafIterator.h.

References chr_, and ref_.

void bpp::AbstractFilterMafIterator::setLogStream

(

OutputStream *

logstream

)

[inline, inherited]

Definition at line 341 of file MafIterator.h.

void bpp::AbstractFilterMafIterator::verbose

(

bool

yn

)

[inline, inherited]

Definition at line 343 of file MafIterator.h.

bool bpp::AbstractFilterMafIterator::verbose

(

)

const [inline, inherited]

Definition at line 342 of file MafIterator.h.

---

Member Data Documentation

std::string bpp::ChromosomeMafIterator::chr_ [private]

Definition at line 442 of file MafIterator.h.

Referenced by nextBlock(), and operator=().

MafBlock* bpp::ChromosomeMafIterator::currentBlock_ [private]

Definition at line 443 of file MafIterator.h.

Referenced by nextBlock().

MafIterator* bpp::AbstractFilterMafIterator::iterator_ [protected, inherited]

Definition at line 323 of file MafIterator.h.

Referenced by bpp::FeatureExtractor::nextBlock(), bpp::FeatureFilterMafIterator::nextBlock(), bpp::PairwiseSequenceStatisticsMafIterator::nextBlock(), bpp::SequenceStatisticsMafIterator::nextBlock(), bpp::QualityFilterMafIterator::nextBlock(), bpp::MaskFilterMafIterator::nextBlock(), bpp::AlignmentFilter2MafIterator::nextBlock(), bpp::AlignmentFilterMafIterator::nextBlock(), bpp::FullGapFilterMafIterator::nextBlock(), bpp::BlockMergerMafIterator::nextBlock(), bpp::DuplicateFilterMafIterator::nextBlock(), nextBlock(), bpp::SequenceFilterMafIterator::nextBlock(), and bpp::AbstractFilterMafIterator::operator=().

OutputStream* bpp::AbstractFilterMafIterator::logstream_ [protected, inherited]

Definition at line 324 of file MafIterator.h.

Referenced by bpp::FeatureExtractor::nextBlock(), bpp::FeatureFilterMafIterator::nextBlock(), bpp::QualityFilterMafIterator::nextBlock(), bpp::MaskFilterMafIterator::nextBlock(), bpp::AlignmentFilter2MafIterator::nextBlock(), bpp::AlignmentFilterMafIterator::nextBlock(), bpp::FullGapFilterMafIterator::nextBlock(), bpp::BlockMergerMafIterator::nextBlock(), bpp::DuplicateFilterMafIterator::nextBlock(), nextBlock(), bpp::SequenceFilterMafIterator::nextBlock(), and bpp::AbstractFilterMafIterator::operator=().

std::string bpp::ChromosomeMafIterator::ref_ [private]

Definition at line 441 of file MafIterator.h.

Referenced by nextBlock(), and operator=().

bool bpp::AbstractFilterMafIterator::verbose_ [protected, inherited]

Definition at line 325 of file MafIterator.h.

Referenced by bpp::FeatureExtractor::nextBlock(), bpp::FeatureFilterMafIterator::nextBlock(), bpp::QualityFilterMafIterator::nextBlock(), bpp::MaskFilterMafIterator::nextBlock(), bpp::AlignmentFilter2MafIterator::nextBlock(), bpp::AlignmentFilterMafIterator::nextBlock(), bpp::FullGapFilterMafIterator::nextBlock(), and bpp::AbstractFilterMafIterator::operator=().

---

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

• Bpp/Seq/Io/MafIterator.h
• Bpp/Seq/Io/MafIterator.cpp