bpp-phyl  2.2.0
bpp::IMultiTree Class Referenceabstract

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

◆ IMultiTree()

bpp::IMultiTree::IMultiTree ( )
inline

Definition at line 197 of file IoTree.h.

◆ ~IMultiTree()

virtual bpp::IMultiTree::~IMultiTree ( )
inlinevirtual

Definition at line 198 of file IoTree.h.

Member Function Documentation

◆ getDataType()

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

Definition at line 68 of file IoTree.h.

◆ read() [1/2]

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

Read trees from a file.

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

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

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

◆ read() [2/2]

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

Read trees from a stream.

Parameters
inThe input stream.
treesThe output trees container.
Exceptions
ExceptionIf 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: