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

Partial implementation of the SiteIterator interface, allowing to loop over a site container. More...

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

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

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

Public Member Functions
	AbstractTemplateSiteContainerIterator (const TemplateSiteContainerInterface< SiteType, SequenceType, HashType > &sites)
	AbstractTemplateSiteContainerIterator (const AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType > &atsi)
AbstractTemplateSiteContainerIterator &	operator= (const AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType > &atsi)
virtual	~AbstractTemplateSiteContainerIterator ()
virtual const SiteType &	nextSite ()=0
virtual bool	hasMoreSites () const=0

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

Detailed Description

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

Partial implementation of the SiteIterator interface, allowing to loop over a site container.

Definition at line 19 of file SiteContainerIterator.h.

Constructor & Destructor Documentation

AbstractTemplateSiteContainerIterator() [1/2]

template<class SiteType , class SequenceType , class HashType >

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

inline

Definition at line 27 of file SiteContainerIterator.h.

AbstractTemplateSiteContainerIterator() [2/2]

template<class SiteType , class SequenceType , class HashType >

bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::AbstractTemplateSiteContainerIterator ( const AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType > &  atsi )

inline

Definition at line 34 of file SiteContainerIterator.h.

~AbstractTemplateSiteContainerIterator()

template<class SiteType , class SequenceType , class HashType >

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

inlinevirtual

Definition at line 48 of file SiteContainerIterator.h.

Member Function Documentation

hasMoreSites()

virtual bool bpp::TemplateSiteIteratorInterface< const SiteType >::hasMoreSites ( ) const

pure virtualinherited

Implemented in bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >, bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >, and bpp::SimpleTemplateSiteContainerIterator< SiteType, SequenceType, HashType >.

nextSite()

virtual const SiteType & bpp::TemplateSiteIteratorInterface< const SiteType >::nextSite ( )

pure virtualinherited

Implemented in bpp::CompleteTemplateSiteContainerIterator< SiteType, SequenceType, HashType >, bpp::NoGapTemplateSiteContainerIterator< SiteType, SequenceType, HashType >, and bpp::SimpleTemplateSiteContainerIterator< SiteType, SequenceType, HashType >.

operator=()

template<class SiteType , class SequenceType , class HashType >

AbstractTemplateSiteContainerIterator& bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::operator= ( const AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType > &  atsi )

inline

Definition at line 40 of file SiteContainerIterator.h.

References bpp::AbstractTemplateSiteContainerIterator< SiteType, SequenceType, HashType >::currentPosition_, 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_

protected

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_

protected

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