bpp::SimpleSiteContainerIterator Class Reference

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

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

Inheritance diagram for bpp::SimpleSiteContainerIterator:

Collaboration diagram for bpp::SimpleSiteContainerIterator:

Public Member Functions
	SimpleSiteContainerIterator (const SiteContainer &sites)
virtual	~SimpleSiteContainerIterator ()
const Site *	nextSite ()
bool	hasMoreSites () const

Protected Attributes
const SiteContainer *	sites_
int	currentPosition_

Detailed Description

Loop over all sites in a SiteContainer.

Definition at line 81 of file SiteContainerIterator.h.

Constructor & Destructor Documentation

SimpleSiteContainerIterator()

SimpleSiteContainerIterator::SimpleSiteContainerIterator

(

const SiteContainer &

sites

)

Definition at line 61 of file SiteContainerIterator.cpp.

~SimpleSiteContainerIterator()

virtual bpp::SimpleSiteContainerIterator::~SimpleSiteContainerIterator ( )

inlinevirtual

Definition at line 85 of file SiteContainerIterator.h.

Member Function Documentation

hasMoreSites()

bool SimpleSiteContainerIterator::hasMoreSites ( ) const

virtual

Implements bpp::ConstSiteIterator.

Definition at line 70 of file SiteContainerIterator.cpp.

References bpp::AlignedValuesContainer::getNumberOfSites(), and bpp::AbstractSiteContainerIterator::sites_.

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

nextSite()

const Site * SimpleSiteContainerIterator::nextSite ( )

virtual

Implements bpp::ConstSiteIterator.

Definition at line 63 of file SiteContainerIterator.cpp.

References bpp::AbstractSiteContainerIterator::currentPosition_, bpp::SiteContainer::getSite(), and bpp::AbstractSiteContainerIterator::sites_.

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

Member Data Documentation

currentPosition_

int bpp::AbstractSiteContainerIterator::currentPosition_

protectedinherited

Definition at line 59 of file SiteContainerIterator.h.

Referenced by bpp::CompleteSiteContainerIterator::CompleteSiteContainerIterator(), nextSite(), bpp::NoGapSiteContainerIterator::nextSite(), bpp::CompleteSiteContainerIterator::nextSite(), bpp::NoGapSiteContainerIterator::NoGapSiteContainerIterator(), and bpp::AbstractSiteContainerIterator::operator=().

sites_

const SiteContainer* bpp::AbstractSiteContainerIterator::sites_

protectedinherited

Definition at line 58 of file SiteContainerIterator.h.

Referenced by hasMoreSites(), bpp::NoGapSiteContainerIterator::hasMoreSites(), bpp::CompleteSiteContainerIterator::hasMoreSites(), bpp::CompleteSiteContainerIterator::nextCompleteSitePosition(), nextSite(), bpp::NoGapSiteContainerIterator::nextSite(), bpp::CompleteSiteContainerIterator::nextSite(), bpp::NoGapSiteContainerIterator::nextSiteWithoutGapPosition(), bpp::AbstractSiteContainerIterator::operator=(), bpp::CompleteSiteContainerIterator::previousCompleteSitePosition(), and bpp::NoGapSiteContainerIterator::previousSiteWithoutGapPosition().

---

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

• Bpp/Seq/Container/SiteContainerIterator.h
• Bpp/Seq/Container/SiteContainerIterator.cpp