bpp-phyl3  3.0.0
bpp::OPhyloDAG Class Referenceabstract

General interface for DAG writers. More...

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

+ Inheritance diagram for bpp::OPhyloDAG:
+ Collaboration diagram for bpp::OPhyloDAG:

Public Member Functions

 OPhyloDAG ()
 
virtual ~OPhyloDAG ()
 
virtual void writePhyloDAG (const PhyloDAG &dag, const std::string &path, bool overwrite) const =0
 Write a DAG to a file. More...
 
virtual void writePhyloDAG (const PhyloDAG &dag, std::ostream &out) const =0
 Write a PhyloDAG 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 DAG writers.

Definition at line 87 of file IoDAG.h.

Constructor & Destructor Documentation

◆ OPhyloDAG()

bpp::OPhyloDAG::OPhyloDAG ( )
inline

Definition at line 91 of file IoDAG.h.

◆ ~OPhyloDAG()

virtual bpp::OPhyloDAG::~OPhyloDAG ( )
inlinevirtual

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

◆ writePhyloDAG() [1/2]

virtual void bpp::OPhyloDAG::writePhyloDAG ( const PhyloDAG &  dag,
const std::string &  path,
bool  overwrite 
) const
pure virtual

Write a DAG to a file.

Parameters
daga PhyloDAG object.
pathThe file path.
overwriteTell if existing file must be overwritten. Otherwise append to the file.
Exceptions
ExceptionIf an error occurred.

Implemented in bpp::AbstractOPhyloDAG.

◆ writePhyloDAG() [2/2]

virtual void bpp::OPhyloDAG::writePhyloDAG ( const PhyloDAG &  dag,
std::ostream &  out 
) const
pure virtual

Write a PhyloDAG to a stream.

Parameters
dagA PhyloDAG object.
outThe output stream.
Exceptions
ExceptionIf an error occurred.

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


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