bpp-phyl3  3.0.0
bpp::AbstractIPhyloTree Class Referenceabstract

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

+ Inheritance diagram for bpp::AbstractIPhyloTree:
+ Collaboration diagram for bpp::AbstractIPhyloTree:

Public Member Functions

 AbstractIPhyloTree ()
 
virtual ~AbstractIPhyloTree ()
 
std::unique_ptr< PhyloTreereadPhyloTree (std::istream &in) const override=0
 Read a tree from a stream. More...
 
std::unique_ptr< PhyloTreereadPhyloTree (const std::string &path) const override
 Read a tree from a file. More...
 
Element getElement (const std::string &elt) const
 
virtual const std::string getDataType () const
 
virtual const std::string getFormatName () const=0
 
virtual const std::string getFormatDescription () const=0
 

Detailed Description

Definition at line 225 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractIPhyloTree()

bpp::AbstractIPhyloTree::AbstractIPhyloTree ( )
inline

Definition at line 229 of file IoTree.h.

◆ ~AbstractIPhyloTree()

virtual bpp::AbstractIPhyloTree::~AbstractIPhyloTree ( )
inlinevirtual

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

◆ getElement()

Element bpp::AbstractIPhyloTree::getElement ( const std::string &  elt) const
inline

Definition at line 245 of file IoTree.h.

◆ readPhyloTree() [1/2]

std::unique_ptr<PhyloTree> bpp::AbstractIPhyloTree::readPhyloTree ( const std::string &  path) const
inlineoverridevirtual

Read a tree from a file.

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

Implements bpp::IPhyloTree.

Definition at line 235 of file IoTree.h.

References readPhyloTree().

◆ readPhyloTree() [2/2]

std::unique_ptr<PhyloTree> bpp::AbstractIPhyloTree::readPhyloTree ( std::istream &  in) const
overridepure virtual

Read a tree from a stream.

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

Implements bpp::IPhyloTree.

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

Referenced by readPhyloTree().


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