bpp-phyl3  3.0.0
bpp::OPhyloTree Class Referenceabstract

General interface for tree writers. More...

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

+ Inheritance diagram for bpp::OPhyloTree:
+ Collaboration diagram for bpp::OPhyloTree:

Public Member Functions

 OPhyloTree ()
 
virtual ~OPhyloTree ()
 
virtual void writePhyloTree (const PhyloTree &tree, const std::string &path, bool overwrite) const =0
 Write a tree to a file. More...
 
virtual void writePhyloTree (const PhyloTree &tree, std::ostream &out) const =0
 Write a tree 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 155 of file IoTree.h.

Constructor & Destructor Documentation

◆ OPhyloTree()

bpp::OPhyloTree::OPhyloTree ( )
inline

Definition at line 159 of file IoTree.h.

◆ ~OPhyloTree()

virtual bpp::OPhyloTree::~OPhyloTree ( )
inlinevirtual

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

◆ writePhyloTree() [1/2]

virtual void bpp::OPhyloTree::writePhyloTree ( const PhyloTree tree,
const std::string &  path,
bool  overwrite 
) const
pure virtual

Write a tree to a file.

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

Implemented in bpp::AbstractOPhyloTree.

Referenced by bpp::PhylogeneticsApplicationTools::writePhyloTrees().

◆ writePhyloTree() [2/2]

virtual void bpp::OPhyloTree::writePhyloTree ( const PhyloTree tree,
std::ostream &  out 
) const
pure virtual

Write a tree to a stream.

Parameters
treeA tree object.
outThe output stream.
Exceptions
ExceptionIf an error occurred.

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


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