bpp-phyl3  3.0.0
bpp::OMultiPhyloDAG Class Referenceabstract

General interface for tree writers. More...

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

+ Inheritance diagram for bpp::OMultiPhyloDAG:
+ Collaboration diagram for bpp::OMultiPhyloDAG:

Public Member Functions

 OMultiPhyloDAG ()
 
virtual ~OMultiPhyloDAG ()
 
virtual void writePhyloDAGs (const std::vector< const PhyloDAG * > &dags, const std::string &path, bool overwrite) const =0
 Write dags to a file. More...
 
virtual void writePhyloDAGs (const std::vector< const PhyloDAG * > &dags, std::ostream &out) const =0
 Write dags to 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 tree writers.

Definition at line 214 of file IoDAG.h.

Constructor & Destructor Documentation

◆ OMultiPhyloDAG()

bpp::OMultiPhyloDAG::OMultiPhyloDAG ( )
inline

Definition at line 218 of file IoDAG.h.

◆ ~OMultiPhyloDAG()

virtual bpp::OMultiPhyloDAG::~OMultiPhyloDAG ( )
inlinevirtual

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

◆ writePhyloDAGs() [1/2]

virtual void bpp::OMultiPhyloDAG::writePhyloDAGs ( const std::vector< const PhyloDAG * > &  dags,
const std::string &  path,
bool  overwrite 
) const
pure virtual

Write dags to a file.

Parameters
dagsA vector of dag objects.
pathThe file path.
overwriteTell if existing file must be overwritten. Otherwise append to the file.

Implemented in bpp::AbstractOMultiPhyloDAG.

◆ writePhyloDAGs() [2/2]

virtual void bpp::OMultiPhyloDAG::writePhyloDAGs ( const std::vector< const PhyloDAG * > &  dags,
std::ostream &  out 
) const
pure virtual

Write dags to a stream.

Parameters
dagsA vector of dag objects.
outThe output stream.
Exceptions
ExceptionIf an error occurred.

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


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