bpp-phyl3  3.0.0
bpp::AbstractIMultiTree Class Referenceabstract

Partial implementation of the IMultiTree interface. More...

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

+ Inheritance diagram for bpp::AbstractIMultiTree:
+ Collaboration diagram for bpp::AbstractIMultiTree:

Public Member Functions

 AbstractIMultiTree ()
 
virtual ~AbstractIMultiTree ()
 
virtual void readTrees (std::istream &in, std::vector< std::unique_ptr< Tree >> &trees) const override=0
 Read trees from a stream. More...
 
virtual void readTrees (const std::string &path, std::vector< std::unique_ptr< Tree >> &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 454 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractIMultiTree()

bpp::AbstractIMultiTree::AbstractIMultiTree ( )
inline

Definition at line 458 of file IoTree.h.

◆ ~AbstractIMultiTree()

virtual bpp::AbstractIMultiTree::~AbstractIMultiTree ( )
inlinevirtual

Definition at line 459 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::AbstractIMultiTree::readTrees ( const std::string &  path,
std::vector< std::unique_ptr< Tree >> &  trees 
) const
inlineoverridevirtual

Read trees from a file.

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

Implements bpp::IMultiTree.

Definition at line 464 of file IoTree.h.

References readTrees().

◆ readTrees() [2/2]

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

Read trees from a stream.

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

Implements bpp::IMultiTree.

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

Referenced by readTrees().


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