bpp-phyl  2.2.0
bpp::AbstractODistanceMatrix Class Referenceabstract

Partial implementation of the ODistanceMatrix interface. More...

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

+ Inheritance diagram for bpp::AbstractODistanceMatrix:
+ Collaboration diagram for bpp::AbstractODistanceMatrix:

Public Member Functions

 AbstractODistanceMatrix ()
 
virtual ~AbstractODistanceMatrix ()
 
virtual void write (const DistanceMatrix &dist, const std::string &path, bool overwrite) const 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

Partial implementation of the ODistanceMatrix interface.

Definition at line 152 of file IoDistanceMatrix.h.

Constructor & Destructor Documentation

◆ AbstractODistanceMatrix()

bpp::AbstractODistanceMatrix::AbstractODistanceMatrix ( )
inline

Definition at line 156 of file IoDistanceMatrix.h.

◆ ~AbstractODistanceMatrix()

virtual bpp::AbstractODistanceMatrix::~AbstractODistanceMatrix ( )
inlinevirtual

Definition at line 157 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::AbstractODistanceMatrix::write ( const DistanceMatrix &  dist,
const std::string &  path,
bool  overwrite 
) const
throw (Exception
)
inlinevirtual

Write a distance matrix to a file.

Parameters
distA distance matrix object.
pathThe file path.
overwriteTell if existing file must be overwritten. Otherwise append to the file.
Exceptions
ExceptionIf an error occured.

Implements bpp::ODistanceMatrix.

Reimplemented in bpp::PhylipDistanceMatrixFormat.

Definition at line 160 of file IoDistanceMatrix.h.

Referenced by bpp::PhylipDistanceMatrixFormat::write().

◆ write() [2/2]

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

Write a distance matrix to a stream.

Parameters
distA distance matrix object.
outThe output stream.
Exceptions
ExceptionIf an error occured.

Implements bpp::ODistanceMatrix.

Implemented in bpp::PhylipDistanceMatrixFormat.


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