bpp::IMultiTree Class Reference

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	read (const std::string &path, std::vector< Tree * > &trees) const =0 throw (Exception)
	Read trees from a file. More...
virtual void	read (std::istream &in, std::vector< Tree * > &trees) const =0 throw (Exception)
	Read trees from a stream. More...
virtual const std::string	getDataType () const

Detailed Description

General interface for multiple trees readers.

Definition at line 193 of file IoTree.h.

Constructor & Destructor Documentation

bpp::IMultiTree::IMultiTree ( )

inline

Definition at line 197 of file IoTree.h.

virtual bpp::IMultiTree::~IMultiTree ( )

inlinevirtual

Definition at line 198 of file IoTree.h.

Member Function Documentation

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

inlinevirtualinherited

Implements bpp::IOFormat.

Definition at line 68 of file IoTree.h.

virtual void bpp::IMultiTree::read ( const std::string &  path, std::vector< Tree * > &  trees  ) const throw (Exception)

pure virtual

Read trees from a file.

Parameters

path	The file path.
trees	The output trees container.

Exceptions

Exception

If an error occured.

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

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

virtual void bpp::IMultiTree::read ( std::istream &  in, std::vector< Tree * > &  trees  ) const throw (Exception)

pure virtual

Read trees from a stream.

Parameters

in	The input stream.
trees	The output trees container.

Exceptions

Exception

If an error occured.

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

---

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

• Bpp/Phyl/Io/IoTree.h