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::CompleteSiteContainerIterator:
Collaboration diagram for bpp::CompleteSiteContainerIterator:
Public Member Functions | |
| CompleteSiteContainerIterator (const SiteContainer &sites) | |
| virtual | ~CompleteSiteContainerIterator () |
| const Site * | nextSite () |
| bool | hasMoreSites () const |
| int | nextCompleteSitePosition (int current) const |
| int | previousCompleteSitePosition (int current) const |
Protected Attributes | |
| const SiteContainer * | sites_ |
| int | currentPosition_ |
Detailed Description
Loop over all complete sites in a SiteContainer (i.e. sites without gap and unresolved characters).
Definition at line 112 of file SiteContainerIterator.h.
Constructor & Destructor Documentation
◆ CompleteSiteContainerIterator()
| CompleteSiteContainerIterator::CompleteSiteContainerIterator | ( | const SiteContainer & | sites | ) |
Definition at line 110 of file SiteContainerIterator.cpp.
References bpp::AbstractSiteContainerIterator::currentPosition_, and nextCompleteSitePosition().
◆ ~CompleteSiteContainerIterator()
|
inlinevirtual |
Definition at line 116 of file SiteContainerIterator.h.
Member Function Documentation
◆ hasMoreSites()
|
virtual |
Implements bpp::ConstSiteIterator.
Definition at line 122 of file SiteContainerIterator.cpp.
References bpp::SiteContainer::getNumberOfSites(), and bpp::AbstractSiteContainerIterator::sites_.
Referenced by bpp::SiteContainerTools::getCompleteSites().
◆ nextCompleteSitePosition()
| int CompleteSiteContainerIterator::nextCompleteSitePosition | ( | int | current | ) | const |
Definition at line 127 of file SiteContainerIterator.cpp.
References bpp::SiteContainer::getSite(), bpp::SiteTools::isComplete(), and bpp::AbstractSiteContainerIterator::sites_.
Referenced by CompleteSiteContainerIterator(), and nextSite().
◆ nextSite()
|
virtual |
Implements bpp::ConstSiteIterator.
Definition at line 115 of file SiteContainerIterator.cpp.
References bpp::AbstractSiteContainerIterator::currentPosition_, bpp::SiteContainer::getSite(), nextCompleteSitePosition(), and bpp::AbstractSiteContainerIterator::sites_.
Referenced by bpp::SiteContainerTools::getCompleteSites().
◆ previousCompleteSitePosition()
| int CompleteSiteContainerIterator::previousCompleteSitePosition | ( | int | current | ) | const |
Definition at line 135 of file SiteContainerIterator.cpp.
References bpp::SiteContainer::getSite(), bpp::SiteTools::isComplete(), and bpp::AbstractSiteContainerIterator::sites_.
Member Data Documentation
◆ currentPosition_
|
protectedinherited |
Definition at line 58 of file SiteContainerIterator.h.
Referenced by CompleteSiteContainerIterator(), bpp::SimpleSiteContainerIterator::nextSite(), bpp::NoGapSiteContainerIterator::nextSite(), nextSite(), bpp::NoGapSiteContainerIterator::NoGapSiteContainerIterator(), and bpp::AbstractSiteContainerIterator::operator=().
◆ sites_
|
protectedinherited |
Definition at line 57 of file SiteContainerIterator.h.
Referenced by bpp::SimpleSiteContainerIterator::hasMoreSites(), bpp::NoGapSiteContainerIterator::hasMoreSites(), hasMoreSites(), nextCompleteSitePosition(), bpp::SimpleSiteContainerIterator::nextSite(), bpp::NoGapSiteContainerIterator::nextSite(), nextSite(), bpp::NoGapSiteContainerIterator::nextSiteWithoutGapPosition(), bpp::AbstractSiteContainerIterator::operator=(), 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
