General interface for distance matrix readers. More...

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

Inheritance diagram for bpp::IDistanceMatrix:

Collaboration diagram for bpp::IDistanceMatrix:

Public Member Functions
	IDistanceMatrix ()

virtual	~IDistanceMatrix ()

virtual std::unique_ptr< DistanceMatrix >	readDistanceMatrix (const std::string &path) const =0
	Read a distance matrix from a file. More...

virtual std::unique_ptr< DistanceMatrix >	readDistanceMatrix (std::istream &in) const =0
	Read a distance matrix from 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 readers.

Definition at line 34 of file IoDistanceMatrix.h.

Constructor & Destructor Documentation

◆ IDistanceMatrix()

bpp::IDistanceMatrix::IDistanceMatrix ( )

inline

Definition at line 38 of file IoDistanceMatrix.h.

◆ ~IDistanceMatrix()

virtual bpp::IDistanceMatrix::~IDistanceMatrix ( )

inlinevirtual

Definition at line 39 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.

◆ readDistanceMatrix() [1/2]

virtual std::unique_ptr<DistanceMatrix> bpp::IDistanceMatrix::readDistanceMatrix ( const std::string & path ) const

pure virtual

Read a distance matrix from a file.

Parameters

path	The file path.

Returns: A new distance matrix object.

Exceptions

Exception If an error occurred.

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

◆ readDistanceMatrix() [2/2]

virtual std::unique_ptr<DistanceMatrix> bpp::IDistanceMatrix::readDistanceMatrix ( std::istream & in ) const