bpp::TemplateISequenceStream< SequenceType > Class Template Reference

The ISequenceStream interface. More...

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

Inheritance diagram for bpp::TemplateISequenceStream< SequenceType >:

Collaboration diagram for bpp::TemplateISequenceStream< SequenceType >:

Public Member Functions
	TemplateISequenceStream ()
virtual	~TemplateISequenceStream ()
virtual bool	nextSequence (std::istream &input, SequenceType &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

template<class SequenceType>
class bpp::TemplateISequenceStream< SequenceType >

The ISequenceStream interface.

Interface for streaming sequences input.

Author

Sylvain Gaillard

Definition at line 26 of file ISequenceStream.h.

Constructor & Destructor Documentation

TemplateISequenceStream()

template<class SequenceType >

bpp::TemplateISequenceStream< SequenceType >::TemplateISequenceStream ( )

inline

Definition at line 29 of file ISequenceStream.h.

~TemplateISequenceStream()

template<class SequenceType >

virtual bpp::TemplateISequenceStream< SequenceType >::~TemplateISequenceStream ( )

inlinevirtual

Definition at line 30 of file ISequenceStream.h.

Member Function Documentation

nextSequence()

template<class SequenceType >

virtual bool bpp::TemplateISequenceStream< SequenceType >::nextSequence ( std::istream &  input, SequenceType &  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.

---

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

• Bpp/Seq/Io/ISequenceStream.h