bpp-phyl3  3.0.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
bpp::AbstractOMultiTree Class Referenceabstract

Partial implementation of the OTree interface. More...

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

+ Inheritance diagram for bpp::AbstractOMultiTree:
+ Collaboration diagram for bpp::AbstractOMultiTree:

Public Member Functions

 AbstractOMultiTree ()
 
virtual ~AbstractOMultiTree ()
 
virtual void writeTrees (const std::vector< const Tree * > &trees, std::ostream &out) const =0
 Write trees to a stream. More...
 
virtual void writeTrees (const std::vector< const Tree * > &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 496 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractOMultiTree()

bpp::AbstractOMultiTree::AbstractOMultiTree ( )
inline

Definition at line 500 of file IoTree.h.

◆ ~AbstractOMultiTree()

virtual bpp::AbstractOMultiTree::~AbstractOMultiTree ( )
inlinevirtual

Definition at line 501 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::AbstractOMultiTree::writeTrees ( const std::vector< const Tree * > &  trees,
const std::string &  path,
bool  overwrite 
) const
inlinevirtual

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.

Implements bpp::OMultiTree.

Definition at line 505 of file IoTree.h.

References writeTrees().

◆ writeTrees() [2/2]

virtual void bpp::AbstractOMultiTree::writeTrees ( const std::vector< const Tree * > &  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.

Implements bpp::OMultiTree.

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

Referenced by writeTrees().


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