General interface for multiple trees readers. More...

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

Inheritance diagram for bpp::IMultiTree:

Collaboration diagram for bpp::IMultiTree:

Public Member Functions
	IMultiTree ()

virtual	~IMultiTree ()

virtual void	readTrees (const std::string &path, std::vector< std::unique_ptr< Tree > > &trees) const =0
	Read trees from a file. More...

virtual void	readTrees (std::istream &in, std::vector< std::unique_ptr< Tree > > &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

General interface for multiple trees readers.

Definition at line 323 of file IoTree.h.

Constructor & Destructor Documentation

◆ IMultiTree()

bpp::IMultiTree::IMultiTree ( )

inline

Definition at line 327 of file IoTree.h.

◆ ~IMultiTree()

virtual bpp::IMultiTree::~IMultiTree ( )

inlinevirtual

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

◆ readTrees() [1/2]

virtual void bpp::IMultiTree::readTrees	(	const std::string &	path,
		std::vector< std::unique_ptr< Tree > > &	trees
	)		const

pure virtual

Read trees from a file.

Parameters

path	The file path.
trees	The output trees container.

Exceptions

Exception If an error occurred.

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

◆ readTrees() [2/2]

virtual void bpp::IMultiTree::readTrees	(	std::istream &	in,
		std::vector< std::unique_ptr< Tree > > &	trees
	)		const