bpp-phyl3  3.0.0
bpp::IMultiPhyloTree Class Referenceabstract

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

+ Inheritance diagram for bpp::IMultiPhyloTree:
+ Collaboration diagram for bpp::IMultiPhyloTree:

Public Member Functions

 IMultiPhyloTree ()
 
virtual ~IMultiPhyloTree ()
 
virtual void readPhyloTrees (const std::string &path, std::vector< std::unique_ptr< PhyloTree >> &trees) const =0
 Read trees from a file. More...
 
virtual void readPhyloTrees (std::istream &in, std::vector< std::unique_ptr< PhyloTree >> &trees) const =0
 Read trees 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

Definition at line 350 of file IoTree.h.

Constructor & Destructor Documentation

◆ IMultiPhyloTree()

bpp::IMultiPhyloTree::IMultiPhyloTree ( )
inline

Definition at line 354 of file IoTree.h.

◆ ~IMultiPhyloTree()

virtual bpp::IMultiPhyloTree::~IMultiPhyloTree ( )
inlinevirtual

Definition at line 355 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::IMultiPhyloTree::readPhyloTrees ( const std::string &  path,
std::vector< std::unique_ptr< PhyloTree >> &  trees 
) const
pure virtual

Read trees from a file.

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

Implemented in bpp::AbstractIMultiPhyloTree.

Referenced by bpp::PhylogeneticsApplicationTools::getPhyloTrees().

◆ readPhyloTrees() [2/2]

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

Read trees from a stream.

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

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


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