bpp::BlockLengthMafIterator Class Reference

Filter maf blocks to keep only the ones with a minimum number of sites. More...

#include <Bpp/Seq/Io/Maf/BlockLengthMafIterator.h>

Inheritance diagram for bpp::BlockLengthMafIterator:

Collaboration diagram for bpp::BlockLengthMafIterator:

Public Member Functions
	BlockLengthMafIterator (MafIterator *iterator, size_t minLength)
void	setLogStream (std::shared_ptr< OutputStream > logstream)
void	addIterationListener (IterationListener *listener)
MafBlock *	nextBlock ()
	Get the next available alignment block. More...
bool	isVerbose () const
void	setVerbose (bool yn)

Protected Member Functions
virtual void	fireIterationStartSignal_ ()
virtual void	fireIterationMoveSignal_ (const MafBlock &currentBlock)
virtual void	fireIterationStopSignal_ ()

Protected Attributes
MafIterator *	iterator_
MafBlock *	currentBlock_
std::shared_ptr< OutputStream >	logstream_
std::vector< IterationListener * >	iterationListeners_
bool	started_
bool	verbose_

Private Member Functions
MafBlock *	analyseCurrentBlock_ () throw (Exception)

Private Attributes
size_t	minLength_

Detailed Description

Filter maf blocks to keep only the ones with a minimum number of sites.

Definition at line 55 of file BlockLengthMafIterator.h.

Constructor & Destructor Documentation

BlockLengthMafIterator()

bpp::BlockLengthMafIterator::BlockLengthMafIterator ( MafIterator *  iterator, size_t  minLength  )

inline

Definition at line 62 of file BlockLengthMafIterator.h.

Member Function Documentation

addIterationListener()

void bpp::AbstractMafIterator::addIterationListener ( IterationListener *  listener )

inlinevirtualinherited

Implements bpp::MafIterator.

Definition at line 99 of file MafIterator.h.

References bpp::AbstractMafIterator::iterationListeners_.

analyseCurrentBlock_()

MafBlock* bpp::BlockLengthMafIterator::analyseCurrentBlock_ ( ) throw ( Exception )

inlineprivatevirtual

Implements bpp::AbstractMafIterator.

Definition at line 68 of file BlockLengthMafIterator.h.

References bpp::AbstractFilterMafIterator::currentBlock_, bpp::MafBlock::getDescription(), bpp::MafBlock::getNumberOfSites(), bpp::AbstractFilterMafIterator::iterator_, bpp::AbstractFilterMafIterator::logstream_, minLength_, and bpp::MafIterator::nextBlock().

fireIterationMoveSignal_()

void AbstractMafIterator::fireIterationMoveSignal_ ( const MafBlock &  currentBlock )

protectedvirtualinherited

Definition at line 57 of file MafIterator.cpp.

Referenced by bpp::AbstractMafIterator::nextBlock().

fireIterationStartSignal_()

void AbstractMafIterator::fireIterationStartSignal_ ( )

protectedvirtualinherited

Definition at line 51 of file MafIterator.cpp.

Referenced by bpp::AbstractMafIterator::nextBlock().

fireIterationStopSignal_()

void AbstractMafIterator::fireIterationStopSignal_ ( )

protectedvirtualinherited

Definition at line 63 of file MafIterator.cpp.

Referenced by bpp::AbstractMafIterator::nextBlock().

isVerbose()

bool bpp::AbstractMafIterator::isVerbose ( ) const

inlinevirtualinherited

Implements bpp::MafIterator.

Definition at line 116 of file MafIterator.h.

References bpp::AbstractMafIterator::verbose_.

nextBlock()

MafBlock* bpp::AbstractMafIterator::nextBlock ( )

inlinevirtualinherited

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 103 of file MafIterator.h.

References bpp::AbstractMafIterator::analyseCurrentBlock_(), bpp::AbstractMafIterator::fireIterationMoveSignal_(), bpp::AbstractMafIterator::fireIterationStartSignal_(), bpp::AbstractMafIterator::fireIterationStopSignal_(), and bpp::AbstractMafIterator::started_.

setLogStream()

void bpp::AbstractFilterMafIterator::setLogStream ( std::shared_ptr< OutputStream >  logstream )

inlineinherited

Definition at line 178 of file MafIterator.h.

References bpp::AbstractFilterMafIterator::logstream_.

setVerbose()

void bpp::AbstractMafIterator::setVerbose ( bool  yn )

inlinevirtualinherited

Implements bpp::MafIterator.

Definition at line 117 of file MafIterator.h.

References bpp::AbstractMafIterator::verbose_.

Member Data Documentation

currentBlock_

MafBlock* bpp::AbstractFilterMafIterator::currentBlock_

protectedinherited

Definition at line 154 of file MafIterator.h.

Referenced by analyseCurrentBlock_(), bpp::BlockSizeMafIterator::analyseCurrentBlock_(), bpp::MafIteratorSynchronizer::analyseCurrentBlock_(), bpp::MsmcOutputMafIterator::analyseCurrentBlock_(), bpp::OrderFilterMafIterator::analyseCurrentBlock_(), bpp::OutputMafIterator::analyseCurrentBlock_(), bpp::PlinkOutputMafIterator::analyseCurrentBlock_(), bpp::SequenceStatisticsMafIterator::analyseCurrentBlock_(), bpp::TableOutputMafIterator::analyseCurrentBlock_(), bpp::VcfOutputMafIterator::analyseCurrentBlock_(), and bpp::AbstractFilterMafIterator::operator=().

iterationListeners_

std::vector<IterationListener*> bpp::AbstractMafIterator::iterationListeners_

protectedinherited

Definition at line 89 of file MafIterator.h.

Referenced by bpp::AbstractMafIterator::addIterationListener().

iterator_

MafIterator* bpp::AbstractFilterMafIterator::iterator_

protectedinherited

Definition at line 153 of file MafIterator.h.

Referenced by analyseCurrentBlock_(), bpp::BlockSizeMafIterator::analyseCurrentBlock_(), bpp::MafIteratorSynchronizer::analyseCurrentBlock_(), bpp::MsmcOutputMafIterator::analyseCurrentBlock_(), bpp::OrderFilterMafIterator::analyseCurrentBlock_(), bpp::OutputMafIterator::analyseCurrentBlock_(), bpp::PlinkOutputMafIterator::analyseCurrentBlock_(), bpp::SequenceStatisticsMafIterator::analyseCurrentBlock_(), bpp::TableOutputMafIterator::analyseCurrentBlock_(), bpp::VcfOutputMafIterator::analyseCurrentBlock_(), and bpp::AbstractFilterMafIterator::operator=().

logstream_

std::shared_ptr<OutputStream> bpp::AbstractFilterMafIterator::logstream_

protectedinherited

Definition at line 155 of file MafIterator.h.

Referenced by analyseCurrentBlock_(), bpp::BlockSizeMafIterator::analyseCurrentBlock_(), bpp::AbstractFilterMafIterator::operator=(), and bpp::AbstractFilterMafIterator::setLogStream().

minLength_

size_t bpp::BlockLengthMafIterator::minLength_

private

Definition at line 59 of file BlockLengthMafIterator.h.

Referenced by analyseCurrentBlock_().

started_

bool bpp::AbstractMafIterator::started_

protectedinherited

Definition at line 90 of file MafIterator.h.

Referenced by bpp::AbstractMafIterator::nextBlock().

verbose_

bool bpp::AbstractMafIterator::verbose_

protectedinherited

Definition at line 91 of file MafIterator.h.

Referenced by bpp::AbstractMafIterator::isVerbose(), and bpp::AbstractMafIterator::setVerbose().

---

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

• Bpp/Seq/Io/Maf/BlockLengthMafIterator.h