bpp-phyl3  3.0.0
bpp::AbstractIMultiPhyloTree Class Referenceabstract

Partial implementation of the IMultiTree interface. More...

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

+ Inheritance diagram for bpp::AbstractIMultiPhyloTree:
+ Collaboration diagram for bpp::AbstractIMultiPhyloTree:

Public Member Functions

 AbstractIMultiPhyloTree ()
 
virtual ~AbstractIMultiPhyloTree ()
 
virtual void readPhyloTrees (std::istream &in, std::vector< std::unique_ptr< PhyloTree >> &trees) const override=0
 Read trees from a stream. More...
 
virtual void readPhyloTrees (const std::string &path, std::vector< std::unique_ptr< PhyloTree >> &trees) const override
 Read trees from a file. More...
 
virtual const std::string getDataType () const
 
virtual const std::string getFormatName () const=0
 
virtual const std::string getFormatDescription () const=0
 

Detailed Description

Partial implementation of the IMultiTree interface.

Definition at line 475 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractIMultiPhyloTree()

bpp::AbstractIMultiPhyloTree::AbstractIMultiPhyloTree ( )
inline

Definition at line 479 of file IoTree.h.

◆ ~AbstractIMultiPhyloTree()

virtual bpp::AbstractIMultiPhyloTree::~AbstractIMultiPhyloTree ( )
inlinevirtual

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

◆ readPhyloTrees() [1/2]

virtual void bpp::AbstractIMultiPhyloTree::readPhyloTrees ( const std::string &  path,
std::vector< std::unique_ptr< PhyloTree >> &  trees 
) const
inlineoverridevirtual

Read trees from a file.

Parameters
pathThe file path.
treesThe output trees container.
Exceptions
ExceptionIf an error occurred.

Implements bpp::IMultiPhyloTree.

Definition at line 485 of file IoTree.h.

References readPhyloTrees().

◆ readPhyloTrees() [2/2]

virtual void bpp::AbstractIMultiPhyloTree::readPhyloTrees ( std::istream &  in,
std::vector< std::unique_ptr< PhyloTree >> &  trees 
) const
overridepure virtual

Read trees from a stream.

Parameters
inThe input stream.
treesThe output trees container.
Exceptions
ExceptionIf an error occurred.

Implements bpp::IMultiPhyloTree.

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

Referenced by readPhyloTrees().


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