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	writeTrees (const std::vector< const Tree * > &trees, const std::string &path, bool overwrite) const =0
	Write trees to a file. More...

virtual void	writeTrees (const std::vector< const Tree * > &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 380 of file IoTree.h.

Constructor & Destructor Documentation

◆ OMultiTree()

bpp::OMultiTree::OMultiTree ( )

inline

Definition at line 384 of file IoTree.h.

◆ ~OMultiTree()

virtual bpp::OMultiTree::~OMultiTree ( )

inlinevirtual

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

◆ writeTrees() [1/2]

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

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

Implemented in bpp::AbstractOMultiTree.

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

◆ writeTrees() [2/2]

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