bpp-seq-omics  2.4.1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
bpp::AbstractFilterMafIterator Class Referenceabstract

Helper class for developping filter for maf blocks. More...

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

+ Inheritance diagram for bpp::AbstractFilterMafIterator:
+ Collaboration diagram for bpp::AbstractFilterMafIterator:

Public Member Functions

 AbstractFilterMafIterator (MafIterator *iterator)
 
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 MafBlock * analyseCurrentBlock_ ()=0
 
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

 AbstractFilterMafIterator (const AbstractFilterMafIterator &it)
 
AbstractFilterMafIterator & operator= (const AbstractFilterMafIterator &it)
 

Detailed Description

Helper class for developping filter for maf blocks.

Definition at line 149 of file MafIterator.h.

Constructor & Destructor Documentation

◆ AbstractFilterMafIterator() [1/2]

bpp::AbstractFilterMafIterator::AbstractFilterMafIterator ( MafIterator *  iterator)
inline

Definition at line 158 of file MafIterator.h.

◆ AbstractFilterMafIterator() [2/2]

bpp::AbstractFilterMafIterator::AbstractFilterMafIterator ( const AbstractFilterMafIterator &  it)
inlineprivate

Definition at line 164 of file MafIterator.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_()

virtual MafBlock* bpp::AbstractMafIterator::analyseCurrentBlock_ ( )
protectedpure virtualinherited

Implemented in bpp::WindowSplitMafIterator, bpp::VcfOutputMafIterator, bpp::TableOutputMafIterator, bpp::SequenceStreamToMafIterator, bpp::SequenceStatisticsMafIterator, bpp::SequenceLDhotOutputMafIterator, bpp::SequenceFilterMafIterator, bpp::RemoveEmptySequencesMafIterator, bpp::QualityFilterMafIterator, bpp::PlinkOutputMafIterator, bpp::OutputMafIterator, bpp::OutputAlignmentMafIterator, bpp::OrphanSequenceFilterMafIterator, bpp::OrderFilterMafIterator, bpp::MsmcOutputMafIterator, bpp::MaskFilterMafIterator, bpp::MafParser, bpp::MafIteratorSynchronizer, bpp::TrashIteratorAdapter, bpp::FullGapFilterMafIterator, bpp::FeatureFilterMafIterator, bpp::FeatureExtractorMafIterator, bpp::EntropyFilterMafIterator, bpp::DuplicateFilterMafIterator, bpp::CoordinateTranslatorMafIterator, bpp::CoordinatesOutputMafIterator, bpp::ConcatenateMafIterator, bpp::ChromosomeMafIterator, bpp::BlockSizeMafIterator, bpp::BlockMergerMafIterator, bpp::BlockLengthMafIterator, bpp::AlignmentFilter2MafIterator, and bpp::AlignmentFilterMafIterator.

Referenced by bpp::AbstractMafIterator::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_.

◆ operator=()

AbstractFilterMafIterator& bpp::AbstractFilterMafIterator::operator= ( const AbstractFilterMafIterator &  it)
inlineprivate

Definition at line 169 of file MafIterator.h.

References currentBlock_, iterator_, and logstream_.

◆ setLogStream()

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

Definition at line 178 of file MafIterator.h.

References 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_
protected

Definition at line 154 of file MafIterator.h.

Referenced by bpp::BlockLengthMafIterator::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 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_
protected

Definition at line 153 of file MafIterator.h.

Referenced by bpp::BlockLengthMafIterator::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 operator=().

◆ logstream_

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

Definition at line 155 of file MafIterator.h.

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

◆ 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: