bpp-phyl3  3.0.0
bpp::IPhyloDAG Class Referenceabstract

General interface for DAG readers. More...

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

+ Inheritance diagram for bpp::IPhyloDAG:
+ Collaboration diagram for bpp::IPhyloDAG:

Public Member Functions

 IPhyloDAG ()
 
virtual ~IPhyloDAG ()
 
virtual std::unique_ptr< PhyloDAG > readPhyloDAG (const std::string &path) const =0
 Read a DAG from a file. More...
 
virtual std::unique_ptr< PhyloDAG > readPhyloDAG (std::istream &in) const =0
 Read a DAG 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 DAG readers.

Definition at line 54 of file IoDAG.h.

Constructor & Destructor Documentation

◆ IPhyloDAG()

bpp::IPhyloDAG::IPhyloDAG ( )
inline

Definition at line 58 of file IoDAG.h.

◆ ~IPhyloDAG()

virtual bpp::IPhyloDAG::~IPhyloDAG ( )
inlinevirtual

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

◆ readPhyloDAG() [1/2]

virtual std::unique_ptr<PhyloDAG> bpp::IPhyloDAG::readPhyloDAG ( const std::string &  path) const
pure virtual

Read a DAG from a file.

Parameters
pathThe file path.
Returns
a new PhyloDAG object.

Implemented in bpp::AbstractIPhyloDAG.

◆ readPhyloDAG() [2/2]

virtual std::unique_ptr<PhyloDAG> bpp::IPhyloDAG::readPhyloDAG ( std::istream &  in) const
pure virtual

Read a DAG from a stream.

Parameters
inThe input stream.
Returns
A new PhyloDAG object.

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


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