bpp::ISequenceStream Class Reference

The ISequenceStream interface. More...

#include <Bpp/Seq/Io/ISequenceStream.h>

Inheritance diagram for bpp::ISequenceStream:

Collaboration diagram for bpp::ISequenceStream:

Public Member Functions
	ISequenceStream ()
virtual	~ISequenceStream ()
virtual bool	nextSequence (std::istream &input, Sequence &seq) const =0
	Read sequence from stream. More...
virtual const std::string	getDataType () const=0
virtual const std::string	getFormatName () const=0
virtual const std::string	getFormatDescription () const=0

Detailed Description

The ISequenceStream interface.

Interface for streaming sequences input.

Author

Sylvain Gaillard

Definition at line 59 of file ISequenceStream.h.

Constructor & Destructor Documentation

ISequenceStream()

bpp::ISequenceStream::ISequenceStream ( )

inline

Definition at line 62 of file ISequenceStream.h.

~ISequenceStream()

virtual bpp::ISequenceStream::~ISequenceStream ( )

inlinevirtual

Definition at line 63 of file ISequenceStream.h.

Member Function Documentation

nextSequence()

virtual bool bpp::ISequenceStream::nextSequence ( std::istream &  input, Sequence &  seq  ) const

pure virtual

Read sequence from stream.

Read one sequence from a stream.

Parameters

input	The stream to read.
seq	The sequence to fill.

Returns

true if a sequence was read or false if not.

Exceptions

Exception

IOExecption and Sequence related Exceptions.

Implemented in bpp::PhredPoly, bpp::PhredPhd, and bpp::Fasta.

Referenced by bpp::StreamSequenceIterator::nextSequence(), bpp::StreamSequenceWithQualityIterator::nextSequence(), bpp::StreamSequenceIterator::StreamSequenceIterator(), and bpp::StreamSequenceWithQualityIterator::StreamSequenceWithQualityIterator().

---

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

• Bpp/Seq/Io/ISequenceStream.h