bpp-phyl3  3.0.0
bpp::IPhyloTree Class Referenceabstract

General interface for tree readers. More...

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

+ Inheritance diagram for bpp::IPhyloTree:
+ Collaboration diagram for bpp::IPhyloTree:

Public Member Functions

 IPhyloTree ()
 
virtual ~IPhyloTree ()
 
virtual std::unique_ptr< PhyloTreereadPhyloTree (const std::string &path) const =0
 Read a tree from a file. More...
 
virtual std::unique_ptr< PhyloTreereadPhyloTree (std::istream &in) const =0
 Read a tree 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 tree readers.

Definition at line 92 of file IoTree.h.

Constructor & Destructor Documentation

◆ IPhyloTree()

bpp::IPhyloTree::IPhyloTree ( )
inline

Definition at line 96 of file IoTree.h.

◆ ~IPhyloTree()

virtual bpp::IPhyloTree::~IPhyloTree ( )
inlinevirtual

Definition at line 97 of file IoTree.h.

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IOTree::getDataType ( ) const
inlinevirtualinherited

Implements bpp::IOFormat.

Definition at line 51 of file IoTree.h.

◆ readPhyloTree() [1/2]

virtual std::unique_ptr<PhyloTree> bpp::IPhyloTree::readPhyloTree ( const std::string &  path) const
pure virtual

Read a tree from a file.

Parameters
pathThe file path.
Returns
A new tree object.
Exceptions
ExceptionIf an error occurred.

Implemented in bpp::AbstractIPhyloTree.

◆ readPhyloTree() [2/2]

virtual std::unique_ptr<PhyloTree> bpp::IPhyloTree::readPhyloTree ( std::istream &  in) const
pure virtual

Read a tree from a stream.

Parameters
inThe input stream.
Returns
A new tree object.
Exceptions
ExceptionIf an error occurred.

Implemented in bpp::AbstractIPhyloTree, bpp::Nhx, bpp::NexusIOTree, and bpp::Newick.


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