General interface for tree writers. More...

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

Inheritance diagram for bpp::OTree:

Collaboration diagram for bpp::OTree:

Public Member Functions
	OTree ()

virtual	~OTree ()

virtual void	writeTree (const Tree &tree, const std::string &path, bool overwrite) const =0
	Write a tree to a file. More...

virtual void	writeTree (const Tree &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 123 of file IoTree.h.

Constructor & Destructor Documentation

◆ OTree()

bpp::OTree::OTree ( )

inline

Definition at line 127 of file IoTree.h.

◆ ~OTree()

virtual bpp::OTree::~OTree ( )

inlinevirtual

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

◆ writeTree() [1/2]

virtual void bpp::OTree::writeTree	(	const Tree &	tree,
		const std::string &	path,
		bool	overwrite
	)		const

pure virtual

Write a tree to a file.

Parameters

tree	A tree object.
path	The file path.
overwrite	Tell if existing file must be overwritten. Otherwise append to the file.

Exceptions

Exception If an error occurred.

Implemented in bpp::AbstractOTree.

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

◆ writeTree() [2/2]

virtual void bpp::OTree::writeTree	(	const Tree &	tree,
		std::ostream &	out
	)		const