bpp::AbstractSequencePositionIterator Class Reference

Partial implementation of the SequencePositionIterator interface. More...

#include <Bpp/Seq/SequencePositionIterators.h>

Inheritance diagram for bpp::AbstractSequencePositionIterator:

Collaboration diagram for bpp::AbstractSequencePositionIterator:

Public Member Functions
	AbstractSequencePositionIterator (const Sequence &seq, unsigned int pos=0)
	AbstractSequencePositionIterator (const AbstractSequencePositionIterator &aspi)
AbstractSequencePositionIterator &	operator= (const AbstractSequencePositionIterator &aspi)
virtual	~AbstractSequencePositionIterator ()
unsigned int	getPosition () const
	Get the actual position of the iterator in the Sequence. More...
void	setPosition (unsigned int pos)
	Set the position of the iterator. More...
int	getValue () const
	Get the numerical value of the Sequence at current position. More...
std::string	getChar () const
	Get the textual value of the Sequence at current position. More...
const Sequence &	getSequence () const
	Get the Sequence on which the iterator loops. More...
virtual SequencePositionIterator &	operator+= (int i)=0
virtual SequencePositionIterator &	operator-= (int i)=0
virtual SequencePositionIterator &	operator++ ()=0
virtual bool	hasMorePositions () const =0
	Tells if there is more positions in the Sequence. More...
Comparison operators
bool	operator== (const SequencePositionIterator &it) const
bool	operator!= (const SequencePositionIterator &it) const

Private Attributes
const Sequence *	sequence_
unsigned int	currentPosition_

Detailed Description

Partial implementation of the SequencePositionIterator interface.

Author

Sylvain Gaillard

Definition at line 106 of file SequencePositionIterators.h.

Constructor & Destructor Documentation

AbstractSequencePositionIterator() [1/2]

bpp::AbstractSequencePositionIterator::AbstractSequencePositionIterator ( const Sequence &  seq, unsigned int  pos = 0  )

inline

Definition at line 115 of file SequencePositionIterators.h.

AbstractSequencePositionIterator() [2/2]

bpp::AbstractSequencePositionIterator::AbstractSequencePositionIterator ( const AbstractSequencePositionIterator &  aspi )

inline

Definition at line 118 of file SequencePositionIterators.h.

~AbstractSequencePositionIterator()

virtual bpp::AbstractSequencePositionIterator::~AbstractSequencePositionIterator ( )

inlinevirtual

Definition at line 128 of file SequencePositionIterators.h.

Member Function Documentation

getChar()

string AbstractSequencePositionIterator::getChar ( ) const

virtual

Get the textual value of the Sequence at current position.

Implements bpp::SequencePositionIterator.

Definition at line 83 of file SequencePositionIterators.cpp.

getPosition()

unsigned int AbstractSequencePositionIterator::getPosition ( ) const

virtual

Get the actual position of the iterator in the Sequence.

Implements bpp::SequencePositionIterator.

Definition at line 71 of file SequencePositionIterators.cpp.

Referenced by bpp::SimpleSequencePositionIterator::hasMorePositions(), bpp::SimpleSequencePositionIterator::operator++(), and bpp::SimpleSequencePositionIterator::operator+=().

getSequence()

const Sequence & AbstractSequencePositionIterator::getSequence ( ) const

virtual

Get the Sequence on which the iterator loops.

Returns

A reference toward the Sequence object.

Implements bpp::SequencePositionIterator.

Definition at line 65 of file SequencePositionIterators.cpp.

Referenced by bpp::SimpleSequencePositionIterator::hasMorePositions().

getValue()

int AbstractSequencePositionIterator::getValue ( ) const

virtual

Get the numerical value of the Sequence at current position.

Implements bpp::SequencePositionIterator.

Definition at line 77 of file SequencePositionIterators.cpp.

hasMorePositions()

virtual bool bpp::SequencePositionIterator::hasMorePositions ( ) const

pure virtualinherited

Tells if there is more positions in the Sequence.

Returns

true if there is more positions in the Sequence

Implemented in bpp::SimpleSequencePositionIterator.

operator!=()

bool AbstractSequencePositionIterator::operator!= ( const SequencePositionIterator &  it ) const

virtual

Implements bpp::SequencePositionIterator.

Definition at line 53 of file SequencePositionIterators.cpp.

References bpp::SequencePositionIterator::getPosition().

operator++()

virtual SequencePositionIterator& bpp::SequencePositionIterator::operator++ ( )

pure virtualinherited

Implemented in bpp::SimpleSequencePositionIterator.

operator+=()

virtual SequencePositionIterator& bpp::SequencePositionIterator::operator+= ( int  i )

pure virtualinherited

Implemented in bpp::SimpleSequencePositionIterator.

operator-=()

virtual SequencePositionIterator& bpp::SequencePositionIterator::operator-= ( int  i )

pure virtualinherited

Implemented in bpp::SimpleSequencePositionIterator.

operator=()

AbstractSequencePositionIterator& bpp::AbstractSequencePositionIterator::operator= ( const AbstractSequencePositionIterator &  aspi )

inline

Definition at line 121 of file SequencePositionIterators.h.

References currentPosition_, and sequence_.

operator==()

bool AbstractSequencePositionIterator::operator== ( const SequencePositionIterator &  it ) const

virtual

Implements bpp::SequencePositionIterator.

Definition at line 47 of file SequencePositionIterators.cpp.

References bpp::SequencePositionIterator::getPosition().

setPosition()

void AbstractSequencePositionIterator::setPosition ( unsigned int  pos )

virtual

Set the position of the iterator.

Parameters

pos	The position on the Sequence

Implements bpp::SequencePositionIterator.

Definition at line 59 of file SequencePositionIterators.cpp.

Referenced by bpp::SimpleSequencePositionIterator::operator++(), and bpp::SimpleSequencePositionIterator::operator+=().

Member Data Documentation

currentPosition_

unsigned int bpp::AbstractSequencePositionIterator::currentPosition_

private

Definition at line 111 of file SequencePositionIterators.h.

Referenced by operator=().

sequence_

const Sequence* bpp::AbstractSequencePositionIterator::sequence_

private

Definition at line 110 of file SequencePositionIterators.h.

Referenced by operator=().

---

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

• Bpp/Seq/SequencePositionIterators.h
• Bpp/Seq/SequencePositionIterators.cpp