Partial implementation of the OAlignment interface. More...

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

Inheritance diagram for bpp::AbstractOAlignment:

Collaboration diagram for bpp::AbstractOAlignment:

Public Member Functions
	AbstractOAlignment ()

virtual	~AbstractOAlignment ()

const std::string	getDataType () const

OAlignment methods:
void	writeAlignment (std::ostream &output, const SiteContainer &sc) const =0 throw (Exception)
	Write a container to a stream. More...

void	writeAlignment (const std::string &path, const SiteContainer &sc, bool overwrite=true) const throw (Exception)
	Write a container to a file. More...

Detailed Description

Partial implementation of the OAlignment interface.

Definition at line 57 of file AbstractOAlignment.h.

Constructor & Destructor Documentation

◆ AbstractOAlignment()

bpp::AbstractOAlignment::AbstractOAlignment ( )

inline

Definition at line 62 of file AbstractOAlignment.h.

◆ ~AbstractOAlignment()

virtual bpp::AbstractOAlignment::~AbstractOAlignment ( )

inlinevirtual

Definition at line 63 of file AbstractOAlignment.h.

Member Function Documentation

◆ getDataType()

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

inlineinherited

Definition at line 65 of file IoSequence.h.

◆ writeAlignment() [1/2]

void bpp::AbstractOAlignment::writeAlignment	(	std::ostream &	output,
		const SiteContainer &	sc
	)		const
throw	(	Exception
	)

pure virtual

Write a container to a stream.

Parameters

output	The output stream where to write.
sc	The container to write.

Exceptions

Exception If the file is not in the specified format.

Implements bpp::OAlignment.

Implemented in bpp::Phylip, bpp::Clustal, and bpp::Stockholm.

Referenced by writeAlignment(), bpp::Stockholm::writeAlignment(), bpp::Clustal::writeAlignment(), and bpp::Phylip::writeAlignment().

◆ writeAlignment() [2/2]

void bpp::AbstractOAlignment::writeAlignment	(	const std::string &	path,
		const SiteContainer &	sc,
		bool	overwrite = `true`
	)		const
throw	(	Exception
	)

inlinevirtual

Write a container to a file.