General interface for distance matrix writers. More...

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

Inheritance diagram for bpp::ODistanceMatrix:

Collaboration diagram for bpp::ODistanceMatrix:

Public Member Functions
	ODistanceMatrix ()

virtual	~ODistanceMatrix ()

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

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

virtual const std::string	getDataType () const

Detailed Description

General interface for distance matrix writers.

Definition at line 100 of file IoDistanceMatrix.h.

Constructor & Destructor Documentation

◆ ODistanceMatrix()

bpp::ODistanceMatrix::ODistanceMatrix ( )

inline

Definition at line 104 of file IoDistanceMatrix.h.

◆ ~ODistanceMatrix()

virtual bpp::ODistanceMatrix::~ODistanceMatrix ( )

inlinevirtual

Definition at line 105 of file IoDistanceMatrix.h.

Member Function Documentation

◆ getDataType()

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

inlinevirtualinherited

Definition at line 65 of file IoDistanceMatrix.h.

◆ write() [1/2]

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

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 occured.

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

◆ write() [2/2]

virtual void bpp::ODistanceMatrix::write	(	const DistanceMatrix &	dist,
		std::ostream &	out
	)		const
throw	(	Exception
	)