bpp-phyl  2.2.0
bpp::IDistanceMatrix Class Referenceabstract

General interface for distance matrix readers. More...

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

+ Inheritance diagram for bpp::IDistanceMatrix:
+ Collaboration diagram for bpp::IDistanceMatrix:

Public Member Functions

 IDistanceMatrix ()
 
virtual ~IDistanceMatrix ()
 
virtual DistanceMatrix * read (const std::string &path) const =0 throw (Exception)
 Read a distance matrix from a file. More...
 
virtual DistanceMatrix * read (std::istream &in) const =0 throw (Exception)
 Read a distance matrix from a stream. More...
 
virtual const std::string getDataType () const
 

Detailed Description

General interface for distance matrix readers.

Definition at line 71 of file IoDistanceMatrix.h.

Constructor & Destructor Documentation

◆ IDistanceMatrix()

bpp::IDistanceMatrix::IDistanceMatrix ( )
inline

Definition at line 75 of file IoDistanceMatrix.h.

◆ ~IDistanceMatrix()

virtual bpp::IDistanceMatrix::~IDistanceMatrix ( )
inlinevirtual

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

◆ read() [1/2]

virtual DistanceMatrix* bpp::IDistanceMatrix::read ( const std::string &  path) const
throw (Exception
)
pure virtual

Read a distance matrix from a file.

Parameters
pathThe file path.
Returns
A new distance matrix object.
Exceptions
ExceptionIf an error occured.

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

◆ read() [2/2]

virtual DistanceMatrix* bpp::IDistanceMatrix::read ( std::istream &  in) const
throw (Exception
)
pure virtual

Read a distance matrix from a stream.

Parameters
inThe input stream.
Returns
A new distance matrix object.
Exceptions
ExceptionIf an error occured.

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


The documentation for this class was generated from the following file: