General interface for distance matrix writers. More...

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

Inheritance diagram for bpp::ODistanceMatrix:

Collaboration diagram for bpp::ODistanceMatrix:

Public Member Functions
	ODistanceMatrix ()

virtual	~ODistanceMatrix ()

virtual void	writeDistanceMatrix (const DistanceMatrix &dist, const std::string &path, bool overwrite) const =0
	Write a distance matrix to a file. More...

virtual void	writeDistanceMatrix (const DistanceMatrix &dist, std::ostream &out) const =0
	Write a distance matrix to a stream. More...

virtual const std::string	getDataType () const

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

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

Detailed Description

General interface for distance matrix writers.

Definition at line 63 of file IoDistanceMatrix.h.

Constructor & Destructor Documentation

◆ ODistanceMatrix()

bpp::ODistanceMatrix::ODistanceMatrix ( )

inline

Definition at line 67 of file IoDistanceMatrix.h.

◆ ~ODistanceMatrix()

virtual bpp::ODistanceMatrix::~ODistanceMatrix ( )

inlinevirtual

Definition at line 68 of file IoDistanceMatrix.h.

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IODistanceMatrix::getDataType ( ) const

inlinevirtualinherited

Implements bpp::IOFormat.

Definition at line 28 of file IoDistanceMatrix.h.

◆ writeDistanceMatrix() [1/2]

virtual void bpp::ODistanceMatrix::writeDistanceMatrix	(	const DistanceMatrix &	dist,
		const std::string &	path,
		bool	overwrite
	)		const

pure virtual

Write a distance matrix to a file.

Parameters

dist	A distance matrix object.
path	The file path.
overwrite	Tell if existing file must be overwritten. Otherwise append to the file.

Exceptions

Exception If an error occurred.

Implemented in bpp::PhylipDistanceMatrixFormat, and bpp::AbstractODistanceMatrix.

◆ writeDistanceMatrix() [2/2]

virtual void bpp::ODistanceMatrix::writeDistanceMatrix	(	const DistanceMatrix &	dist,
		std::ostream &	out
	)		const