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

Inheritance diagram for bpp::AbstractIProbabilisticAlignment:

Collaboration diagram for bpp::AbstractIProbabilisticAlignment:

Public Member Functions
	AbstractIProbabilisticAlignment ()

virtual	~AbstractIProbabilisticAlignment ()

const std::string	getDataType () const

virtual const std::string	getFormatName () const=0

virtual const std::string	getFormatDescription () const=0

IProbabilisticAlignment methods:
void	readAlignment (std::istream &input, ProbabilisticSequenceContainerInterface &sc) const override
	Add sequences to a container from a stream. More...

void	readAlignment (const std::string &path, ProbabilisticSequenceContainerInterface &sc) const override
	Add sequences to a container from a file. More...

std::unique_ptr< ProbabilisticSiteContainerInterface >	readAlignment (const std::string &path, std::shared_ptr< const Alphabet > alpha) const override
	Create a new container from a file. More...

std::unique_ptr< ProbabilisticSiteContainerInterface >	readAlignment (std::istream &input, std::shared_ptr< const Alphabet > alpha) const override
	Create a new container from a stream. More...

Protected Member Functions
virtual void	appendAlignmentFromStream (std::istream &input, ProbabilisticSequenceContainerInterface &sc) const =0
	Append sequences to a container from a stream. More...

virtual void	appendAlignmentFromFile (const std::string &path, ProbabilisticSequenceContainerInterface &sc) const
	Append sequences to a container from a file. More...

virtual std::unique_ptr< ProbabilisticSiteContainerInterface >	readAlignmentFromStream (std::istream &input, std::shared_ptr< const Alphabet > &alpha) const
	Read sequences from a stream. More...

virtual std::unique_ptr< ProbabilisticSiteContainerInterface >	readAlignmentFromFile (const std::string &path, std::shared_ptr< const Alphabet > &alpha) const
	Read sequences from a file. More...

Detailed Description

Definition at line 184 of file AbstractIAlignment.h.

Constructor & Destructor Documentation

◆ AbstractIProbabilisticAlignment()

bpp::AbstractIProbabilisticAlignment::AbstractIProbabilisticAlignment ( )

inline

Definition at line 188 of file AbstractIAlignment.h.

◆ ~AbstractIProbabilisticAlignment()

virtual bpp::AbstractIProbabilisticAlignment::~AbstractIProbabilisticAlignment ( )

inlinevirtual

Definition at line 189 of file AbstractIAlignment.h.

Member Function Documentation

◆ appendAlignmentFromFile()

virtual void bpp::AbstractIProbabilisticAlignment::appendAlignmentFromFile	(	const std::string &	path,
		ProbabilisticSequenceContainerInterface &	sc
	)		const

inlineprotectedvirtual

Append sequences to a container from a file.

Parameters

path	The path to the file to read.
sc	The sequence container to update.

Exceptions

Exception If the file is not in the specified format.

Definition at line 250 of file AbstractIAlignment.h.

References appendAlignmentFromStream().

Referenced by readAlignment(), readAlignmentFromFile(), and bpp::AbstractIProbabilisticAlignment2::readSequences().

◆ appendAlignmentFromStream()

virtual void bpp::AbstractIProbabilisticAlignment::appendAlignmentFromStream	(	std::istream &	input,
		ProbabilisticSequenceContainerInterface &	sc
	)		const

protectedpure virtual

Append sequences to a container from a stream.

This is the unique method to implement!

Parameters

input	The input stream to read.
sc	The sequence container to update.

Implemented in bpp::Pasta.

Referenced by appendAlignmentFromFile(), readAlignment(), readAlignmentFromStream(), and bpp::AbstractIProbabilisticAlignment2::readSequences().

◆ getDataType()

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

inlinevirtualinherited

Implements bpp::IOFormat.

Reimplemented in bpp::Pasta.

Definition at line 44 of file IoSequence.h.

◆ readAlignment() [1/4]

void bpp::AbstractIProbabilisticAlignment::readAlignment	(	const std::string &	path,
		ProbabilisticSequenceContainerInterface &	sc
	)		const

inlineoverridevirtual

Add sequences to a container from a file.

Parameters

path	The path to the file to read.
sc	The sequence container to update.

Implements bpp::IProbabilisticAlignment.

Definition at line 215 of file AbstractIAlignment.h.

References appendAlignmentFromFile().

◆ readAlignment() [2/4]

std::unique_ptr<ProbabilisticSiteContainerInterface> bpp::AbstractIProbabilisticAlignment::readAlignment	(	const std::string &	path,
		std::shared_ptr< const Alphabet >	alpha
	)		const

inlineoverridevirtual

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 ProbabilisticSiteContainer object.

Implements bpp::IProbabilisticAlignment.

Definition at line 220 of file AbstractIAlignment.h.

References readAlignmentFromFile().

◆ readAlignment() [3/4]

void bpp::AbstractIProbabilisticAlignment::readAlignment	(	std::istream &	input,
		ProbabilisticSequenceContainerInterface &	sc
	)		const

inlineoverridevirtual

Add sequences to a container from a stream.

Parameters

input	The input stream to read.
sc	The sequence container to update.

Implements bpp::IProbabilisticAlignment.

Definition at line 204 of file AbstractIAlignment.h.

References appendAlignmentFromStream().

Referenced by bpp::AbstractIProbabilisticAlignment2::readSequences().

◆ readAlignment() [4/4]

std::unique_ptr<ProbabilisticSiteContainerInterface> bpp::AbstractIProbabilisticAlignment::readAlignment	(	std::istream &	input,
		std::shared_ptr< const Alphabet >	alpha
	)		const

inlineoverridevirtual

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 ProbabilisticSiteContainer object.

Implements bpp::IProbabilisticAlignment.

Definition at line 225 of file AbstractIAlignment.h.

References readAlignmentFromStream().

◆ readAlignmentFromFile()

virtual std::unique_ptr<ProbabilisticSiteContainerInterface> bpp::AbstractIProbabilisticAlignment::readAlignmentFromFile	(	const std::string &	path,
		std::shared_ptr< const Alphabet > &	alpha
	)		const

inlineprotectedvirtual

Read sequences from a file.

Parameters

path	The path to the file to read.
alpha	The alphabet to use.

Returns: A sequence container.

Definition at line 280 of file AbstractIAlignment.h.

References appendAlignmentFromFile().

Referenced by readAlignment().

◆ readAlignmentFromStream()

virtual std::unique_ptr<ProbabilisticSiteContainerInterface> bpp::AbstractIProbabilisticAlignment::readAlignmentFromStream	(	std::istream &	input,
		std::shared_ptr< const Alphabet > &	alpha
	)		const

inlineprotectedvirtual

Read sequences from a stream.

Parameters

input	The input stream to read.
alpha	The alphabet to use.

Returns: A sequence container.

Definition at line 266 of file AbstractIAlignment.h.

References appendAlignmentFromStream().

Referenced by readAlignment().

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

Bpp/Seq/Io/AbstractIAlignment.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AbstractIProbabilisticAlignment()

◆ ~AbstractIProbabilisticAlignment()

Member Function Documentation

◆ appendAlignmentFromFile()

◆ appendAlignmentFromStream()

◆ getDataType()

◆ readAlignment() [1/4]

◆ readAlignment() [2/4]

◆ readAlignment() [3/4]

◆ readAlignment() [4/4]

◆ readAlignmentFromFile()

◆ readAlignmentFromStream()