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

Loop over all sites in a SiteContainer. More...

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

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

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

Public Member Functions
	SimpleTemplateSiteContainerIterator (const TemplateSiteContainerInterface< SiteType, SequenceType, HashType > &sites)
virtual	~SimpleTemplateSiteContainerIterator ()
const SiteType &	nextSite () override
bool	hasMoreSites () const override

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

Detailed Description

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

Loop over all sites in a SiteContainer.

Definition at line 56 of file SiteContainerIterator.h.

Constructor & Destructor Documentation

SimpleTemplateSiteContainerIterator()

template<class SiteType , class SequenceType , class HashType >

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

inline

Definition at line 64 of file SiteContainerIterator.h.

~SimpleTemplateSiteContainerIterator()

template<class SiteType , class SequenceType , class HashType >

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

inlinevirtual

Definition at line 69 of file SiteContainerIterator.h.

Member Function Documentation

hasMoreSites()

template<class SiteType , class SequenceType , class HashType >

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

inlineoverridevirtual

Implements bpp::TemplateSiteIteratorInterface< const SiteType >.

Definition at line 79 of file SiteContainerIterator.h.

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

Referenced by bpp::SiteContainerTools::getConsensus().

nextSite()

template<class SiteType , class SequenceType , class HashType >

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

inlineoverridevirtual

Implements bpp::TemplateSiteIteratorInterface< const SiteType >.

Definition at line 72 of file SiteContainerIterator.h.

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

Referenced by bpp::SiteContainerTools::getConsensus().

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