The OProbabilisticAlignment interface. More...

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

Inheritance diagram for bpp::OProbabilisticAlignment:

Collaboration diagram for bpp::OProbabilisticAlignment:

Public Member Functions
	OProbabilisticAlignment ()

virtual	~OProbabilisticAlignment ()

virtual void	writeAlignment (std::ostream &output, const ProbabilisticSiteContainerInterface &sc) const =0
	Write a container to a stream. More...

virtual void	writeAlignment (const std::string &path, const ProbabilisticSiteContainerInterface &sc, bool overwrite) const =0
	Write a container to 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 OProbabilisticAlignment interface.

This interface defines the basic methods for writing alignments to a file.

Definition at line 125 of file OSequence.h.

Constructor & Destructor Documentation

◆ OProbabilisticAlignment()

bpp::OProbabilisticAlignment::OProbabilisticAlignment ( )

inline

Definition at line 129 of file OSequence.h.

◆ ~OProbabilisticAlignment()

virtual bpp::OProbabilisticAlignment::~OProbabilisticAlignment ( )

inlinevirtual

Definition at line 130 of file OSequence.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.

◆ writeAlignment() [1/2]

virtual void bpp::OProbabilisticAlignment::writeAlignment	(	const std::string &	path,
		const ProbabilisticSiteContainerInterface &	sc,
		bool	overwrite
	)		const

pure virtual

Write a container to a file.

Parameters

path	The path to the file to write.
sc	The container to write.
overwrite	If true the sequences are written at the beginning of the file instead of being appended. Any previous content will be lost.

Implemented in bpp::AbstractOProbabilisticSequence2, and bpp::AbstractOProbabilisticAlignment.

◆ writeAlignment() [2/2]

virtual void bpp::OProbabilisticAlignment::writeAlignment	(	std::ostream &	output,
		const ProbabilisticSiteContainerInterface &	sc
	)		const