bpp-phyl3  3.0.0
bpp::AbstractOTree Class Referenceabstract

Partial implementation of the OTree interface. More...

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

+ Inheritance diagram for bpp::AbstractOTree:
+ Collaboration diagram for bpp::AbstractOTree:

Public Member Functions

 AbstractOTree ()
 
virtual ~AbstractOTree ()
 
virtual void writeTree (const Tree &tree, std::ostream &out) const =0
 Write a tree to a stream. More...
 
virtual void writeTree (const Tree &tree, const std::string &path, bool overwrite) const
 Write a tree 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 254 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractOTree()

bpp::AbstractOTree::AbstractOTree ( )
inline

Definition at line 258 of file IoTree.h.

◆ ~AbstractOTree()

virtual bpp::AbstractOTree::~AbstractOTree ( )
inlinevirtual

Definition at line 259 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::AbstractOTree::writeTree ( const Tree tree,
const std::string &  path,
bool  overwrite 
) const
inlinevirtual

Write a tree to a file.

Parameters
treeA tree object.
pathThe file path.
overwriteTell if existing file must be overwritten. Otherwise append to the file.
Exceptions
ExceptionIf an error occurred.

Implements bpp::OTree.

Definition at line 263 of file IoTree.h.

References bpp::IOException::what(), and writeTree().

◆ writeTree() [2/2]

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

Write a tree to a stream.

Parameters
treeA tree object.
outThe output stream.
Exceptions
ExceptionIf an error occurred.

Implements bpp::OTree.

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

Referenced by writeTree().


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