General interface for tree writers. More...

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

Inheritance diagram for bpp::OMultiTree:

Collaboration diagram for bpp::OMultiTree:

Public Member Functions
	OMultiTree ()

virtual	~OMultiTree ()

virtual void	write (const std::vector< Tree *> &trees, const std::string &path, bool overwrite) const =0 throw (Exception)
	Write trees to a file. More...

virtual void	write (const std::vector< Tree *> &trees, std::ostream &out) const =0 throw (Exception)
	Write trees to a stream. More...

virtual const std::string	getDataType () const

Detailed Description

General interface for tree writers.

Definition at line 222 of file IoTree.h.

Constructor & Destructor Documentation

◆ OMultiTree()

bpp::OMultiTree::OMultiTree ( )

inline

Definition at line 226 of file IoTree.h.

◆ ~OMultiTree()

virtual bpp::OMultiTree::~OMultiTree ( )

inlinevirtual

Definition at line 227 of file IoTree.h.

Member Function Documentation

◆ getDataType()

virtual const std::string bpp::IOTree::getDataType ( ) const

inlinevirtualinherited

Definition at line 68 of file IoTree.h.

◆ write() [1/2]

virtual void bpp::OMultiTree::write	(	const std::vector< Tree *> &	trees,
		const std::string &	path,
		bool	overwrite
	)		const
throw	(	Exception
	)

pure virtual

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 occured.

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

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

◆ write() [2/2]

virtual void bpp::OMultiTree::write	(	const std::vector< Tree *> &	trees,
		std::ostream &	out
	)		const
throw	(	Exception
	)