bpp::AbstractOMultiPhyloTree Class Reference

Partial implementation of the OTree interface. More...

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

Inheritance diagram for bpp::AbstractOMultiPhyloTree:

Collaboration diagram for bpp::AbstractOMultiPhyloTree:

Public Member Functions
	AbstractOMultiPhyloTree ()
virtual	~AbstractOMultiPhyloTree ()
virtual void	writePhyloTrees (const std::vector< const PhyloTree * > &trees, std::ostream &out) const =0
	Write trees to a stream. More...
virtual void	writePhyloTrees (const std::vector< const PhyloTree * > &trees, const std::string &path, bool overwrite) const
	Write trees to a file. More...
virtual const std::string	getDataType () const
virtual const std::string	getFormatName () const=0
virtual const std::string	getFormatDescription () const=0

Detailed Description

Partial implementation of the OTree interface.

Definition at line 518 of file IoTree.h.

Constructor & Destructor Documentation

AbstractOMultiPhyloTree()

bpp::AbstractOMultiPhyloTree::AbstractOMultiPhyloTree ( )

inline

Definition at line 522 of file IoTree.h.

~AbstractOMultiPhyloTree()

virtual bpp::AbstractOMultiPhyloTree::~AbstractOMultiPhyloTree ( )

inlinevirtual

Definition at line 523 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::AbstractOMultiPhyloTree::writePhyloTrees ( const std::vector< const PhyloTree * > &  trees, const std::string &  path, bool  overwrite  ) const

inlinevirtual

Write trees to a file.

Parameters

trees	A vector of tree objects.
path	The file path.
overwrite	Tell if existing file must be overwritten. Otherwise append to the file.

Exceptions

Exception

If an error occurred.

Implements bpp::OMultiPhyloTree.

Definition at line 528 of file IoTree.h.

References writePhyloTrees().

writePhyloTrees() [2/2]

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

pure virtual

Write trees to a stream.

Parameters

trees	A vector of tree objects.
out	The output stream.

Exceptions

Exception

If an error occurred.

Implements bpp::OMultiPhyloTree.

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

Referenced by writePhyloTrees().

---

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

• Bpp/Phyl/Io/IoTree.h