bpp-phyl3  3.0.0
bpp::OMultiPhyloTree Class Referenceabstract

General interface for tree writers. More...

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

+ Inheritance diagram for bpp::OMultiPhyloTree:
+ Collaboration diagram for bpp::OMultiPhyloTree:

Public Member Functions

 OMultiPhyloTree ()
 
virtual ~OMultiPhyloTree ()
 
virtual void writePhyloTrees (const std::vector< const PhyloTree * > &trees, const std::string &path, bool overwrite) const =0
 Write trees to a file. More...
 
virtual void writePhyloTrees (const std::vector< const PhyloTree * > &trees, std::ostream &out) const =0
 Write trees 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 417 of file IoTree.h.

Constructor & Destructor Documentation

◆ OMultiPhyloTree()

bpp::OMultiPhyloTree::OMultiPhyloTree ( )
inline

Definition at line 421 of file IoTree.h.

◆ ~OMultiPhyloTree()

virtual bpp::OMultiPhyloTree::~OMultiPhyloTree ( )
inlinevirtual

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

◆ writePhyloTrees() [1/2]

virtual void bpp::OMultiPhyloTree::writePhyloTrees ( const std::vector< const PhyloTree * > &  trees,
const std::string &  path,
bool  overwrite 
) const
pure virtual

Write trees to a file.

Parameters
treesA vector of tree objects.
pathThe file path.
overwriteTell if existing file must be overwritten. Otherwise append to the file.
Exceptions
ExceptionIf an error occurred.

Implemented in bpp::AbstractOMultiPhyloTree.

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

◆ writePhyloTrees() [2/2]

virtual void bpp::OMultiPhyloTree::writePhyloTrees ( const std::vector< const PhyloTree * > &  trees,
std::ostream &  out 
) const
pure virtual

Write trees to a stream.

Parameters
treesA vector of tree objects.
outThe output stream.
Exceptions
ExceptionIf an error occurred.

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


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