bpp::IProbabilisticSequence Class Reference

The IProbabilisticSequence interface. More...

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

Inheritance diagram for bpp::IProbabilisticSequence:

Collaboration diagram for bpp::IProbabilisticSequence:

Public Member Functions
	IProbabilisticSequence ()
virtual	~IProbabilisticSequence ()
virtual void	readSequences (std::istream &input, ProbabilisticSequenceContainerInterface &container) const =0
	Create a new container from a stream. More...
virtual void	readSequences (const std::string &path, ProbabilisticSequenceContainerInterface &container) const =0
	Create a new container from a file. More...
virtual std::unique_ptr< ProbabilisticSequenceContainerInterface >	readSequences (std::istream &input, std::shared_ptr< const Alphabet > alpha) const =0
	Create a new container from a stream. More...
virtual std::unique_ptr< ProbabilisticSequenceContainerInterface >	readSequences (const std::string &path, std::shared_ptr< const Alphabet > alpha) const =0
	Create a new container from a file. More...
const std::string	getDataType () const
virtual const std::string	getFormatName () const=0
virtual const std::string	getFormatDescription () const=0

Detailed Description

The IProbabilisticSequence interface.

This interface defines the basic methods for reading aligned values from a file.

Definition at line 148 of file ISequence.h.

Constructor & Destructor Documentation

IProbabilisticSequence()

bpp::IProbabilisticSequence::IProbabilisticSequence ( )

inline

Definition at line 152 of file ISequence.h.

~IProbabilisticSequence()

virtual bpp::IProbabilisticSequence::~IProbabilisticSequence ( )

inlinevirtual

Definition at line 153 of file ISequence.h.

Member Function Documentation

getDataType()

const std::string bpp::IOProbabilisticSequence::getDataType ( ) const

inlinevirtualinherited

Implements bpp::IOFormat.

Reimplemented in bpp::Pasta.

Definition at line 44 of file IoSequence.h.

readSequences() [1/4]

virtual void bpp::IProbabilisticSequence::readSequences ( const std::string &  path, ProbabilisticSequenceContainerInterface &  container  ) const

pure virtual

Create a new container from a file.

Parameters

path	The path to the file to read.
container	The container where to add data.

Exceptions

Exception

If the file is not in the specified format.

Implemented in bpp::AbstractIProbabilisticSequence, and bpp::AbstractIProbabilisticAlignment2.

readSequences() [2/4]

virtual std::unique_ptr<ProbabilisticSequenceContainerInterface> bpp::IProbabilisticSequence::readSequences ( const std::string &  path, std::shared_ptr< const Alphabet >  alpha  ) const

pure virtual

Create a new container from a file.

Parameters

path	The path to the file to read.
alpha	The alphabet to be associated to the container.

Returns

A new ProbabilisticSequenceContainer object.

Implemented in bpp::AbstractIProbabilisticSequence, and bpp::AbstractIProbabilisticAlignment2.

readSequences() [3/4]

virtual void bpp::IProbabilisticSequence::readSequences ( std::istream &  input, ProbabilisticSequenceContainerInterface &  container  ) const

pure virtual

Create a new container from a stream.

Parameters

input	The input stream to read.
container	The container where to add data.

Exceptions

Exception

If the file is not in the specified format.

Implemented in bpp::AbstractIProbabilisticSequence, and bpp::AbstractIProbabilisticAlignment2.

readSequences() [4/4]

virtual std::unique_ptr<ProbabilisticSequenceContainerInterface> bpp::IProbabilisticSequence::readSequences ( std::istream &  input, std::shared_ptr< const Alphabet >  alpha  ) const

pure virtual

Create a new container from a stream.

Parameters

input	The input stream to read.
alpha	The alphabet to be associated to the container.

Returns

A new ProbabilisticSequenceContainer object.

Implemented in bpp::AbstractIProbabilisticSequence, and bpp::AbstractIProbabilisticAlignment2.

---

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

• Bpp/Seq/Io/ISequence.h