bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType > Class Template Reference

Loop over all complete sites in a SiteContainer (i.e. sites without gap and unresolved characters). More...

#include <Bpp/Seq/Container/SiteContainerIterator.h>

Inheritance diagram for bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >:

Collaboration diagram for bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >:

Public Member Functions
	CompleteTemplateSiteContainerIterator (const TemplateSiteContainerInterface< SiteType, SequenceType, HashType > &sites)
virtual	~CompleteTemplateSiteContainerIterator ()
const SiteType &	nextSite () override
bool	hasMoreSites () const override
long int	nextCompleteSitePosition (long int current) const
long int	previousCompleteSitePosition (long int current) const

Protected Attributes
const TemplateSiteContainerInterface< SiteType, SequenceType, HashType > *	sites_
long int	currentPosition_

Detailed Description

template<class SiteType, class SequenceType, class HashType>
class bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >

Loop over all complete sites in a SiteContainer (i.e. sites without gap and unresolved characters).

Definition at line 144 of file SiteContainerIterator.h.

Constructor & Destructor Documentation

CompleteTemplateSiteContainerIterator()

template<class SiteType , class SequenceType , class HashType >

bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::CompleteTemplateSiteContainerIterator ( const TemplateSiteContainerInterface< SiteType, SequenceType, HashType > &  sites )

inline

Definition at line 152 of file SiteContainerIterator.h.

References bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::currentPosition_, and bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextCompleteSitePosition().

~CompleteTemplateSiteContainerIterator()

template<class SiteType , class SequenceType , class HashType >

virtual bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::~CompleteTemplateSiteContainerIterator ( )

inlinevirtual

Definition at line 159 of file SiteContainerIterator.h.

Member Function Documentation

hasMoreSites()

template<class SiteType , class SequenceType , class HashType >

bool bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::hasMoreSites ( ) const

inlineoverridevirtual

Implements bpp::TemplateSiteIteratorInterface< const SiteType >.

Definition at line 169 of file SiteContainerIterator.h.

References bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::sites_.

nextCompleteSitePosition()

template<class SiteType , class SequenceType , class HashType >

long int bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextCompleteSitePosition ( long int  current ) const

inline

Definition at line 174 of file SiteContainerIterator.h.

References bpp::SymbolListTools::isComplete(), and bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::sites_.

Referenced by bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::CompleteTemplateSiteContainerIterator(), and bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite().

nextSite()

template<class SiteType , class SequenceType , class HashType >

const SiteType& bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite ( )

inlineoverridevirtual

Implements bpp::TemplateSiteIteratorInterface< const SiteType >.

Definition at line 162 of file SiteContainerIterator.h.

References bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::currentPosition_, bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextCompleteSitePosition(), and bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::sites_.

previousCompleteSitePosition()

template<class SiteType , class SequenceType , class HashType >

long int bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::previousCompleteSitePosition ( long int  current ) const

inline

Definition at line 182 of file SiteContainerIterator.h.

References bpp::SymbolListTools::isComplete(), and bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::sites_.

Member Data Documentation

currentPosition_

template<class SiteType , class SequenceType , class HashType >

long int bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::currentPosition_

protectedinherited

Definition at line 24 of file SiteContainerIterator.h.

Referenced by bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::CompleteTemplateSiteContainerIterator(), bpp::SimpleTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::hasMoreSites(), bpp::SimpleTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite(), bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite(), bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite(), bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::NoGapTemplateSiteContainerIterator(), and bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::operator=().

sites_

template<class SiteType , class SequenceType , class HashType >

const TemplateSiteContainerInterface<SiteType, SequenceType, HashType>* bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::sites_

protectedinherited

Definition at line 23 of file SiteContainerIterator.h.

Referenced by bpp::SimpleTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::hasMoreSites(), bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::hasMoreSites(), bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::hasMoreSites(), bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextCompleteSitePosition(), bpp::SimpleTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite(), bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite(), bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSite(), bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::nextSiteWithoutGapPosition(), bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::operator=(), bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::previousCompleteSitePosition(), and bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::previousSiteWithoutGapPosition().

---

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

• Bpp/Seq/Container/SiteContainerIterator.h