bpp-phyl3  3.0.0
bpp::IMultiPhyloDAG Class Referenceabstract

General interface for multiple trees readers. More...

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

+ Inheritance diagram for bpp::IMultiPhyloDAG:
+ Collaboration diagram for bpp::IMultiPhyloDAG:

Public Member Functions

 IMultiPhyloDAG ()
 
virtual ~IMultiPhyloDAG ()
 
virtual void readPhyloDAGs (const std::string &path, std::vector< std::unique_ptr< PhyloDAG >> &dags) const =0
 Read dags from a file. More...
 
virtual void readPhyloDAGs (std::istream &in, std::vector< std::unique_ptr< PhyloDAG >> &dags) const =0
 Read dags 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 184 of file IoDAG.h.

Constructor & Destructor Documentation

◆ IMultiPhyloDAG()

bpp::IMultiPhyloDAG::IMultiPhyloDAG ( )
inline

Definition at line 188 of file IoDAG.h.

◆ ~IMultiPhyloDAG()

virtual bpp::IMultiPhyloDAG::~IMultiPhyloDAG ( )
inlinevirtual

Definition at line 189 of file IoDAG.h.

Member Function Documentation

◆ getDataType()

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

Implements bpp::IOFormat.

Definition at line 48 of file IoDAG.h.

◆ readPhyloDAGs() [1/2]

virtual void bpp::IMultiPhyloDAG::readPhyloDAGs ( const std::string &  path,
std::vector< std::unique_ptr< PhyloDAG >> &  dags 
) const
pure virtual

Read dags from a file.

Parameters
pathThe file path.
dagsThe output dags vector.
Exceptions
ExceptionIf an error occurred.

Implemented in bpp::AbstractIMultiPhyloDAG.

◆ readPhyloDAGs() [2/2]

virtual void bpp::IMultiPhyloDAG::readPhyloDAGs ( std::istream &  in,
std::vector< std::unique_ptr< PhyloDAG >> &  dags 
) const
pure virtual

Read dags from a stream.

Parameters
inThe input stream.
dagsThe output dags container.
Exceptions
ExceptionIf an error occurred.

Implemented in bpp::AbstractIMultiPhyloDAG, and bpp::ExtendedNewick.


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