bpp::AbstractITree Class Reference

Partial implementation of the ITree interface. More...

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

Inheritance diagram for bpp::AbstractITree:

Collaboration diagram for bpp::AbstractITree:

Public Member Functions
	AbstractITree ()
virtual	~AbstractITree ()
std::unique_ptr< Tree >	readTree (std::istream &in) const override
	Read a tree from a stream. More...
std::unique_ptr< Tree >	readTree (const std::string &path) const override
	Read a tree from a file. More...
virtual std::unique_ptr< TreeTemplate< Node > >	readTreeTemplate (std::istream &in) const =0
virtual std::unique_ptr< TreeTemplate< Node > >	readTreeTemplate (const std::string &path) const
virtual Element	getElement (const std::string &elt) const
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 ITree interface.

Definition at line 187 of file IoTree.h.

Constructor & Destructor Documentation

AbstractITree()

bpp::AbstractITree::AbstractITree ( )

inline

Definition at line 191 of file IoTree.h.

~AbstractITree()

virtual bpp::AbstractITree::~AbstractITree ( )

inlinevirtual

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

getElement()

virtual Element bpp::AbstractITree::getElement ( const std::string &  elt ) const

inlinevirtual

Reimplemented in bpp::Newick, and bpp::Nhx.

Definition at line 219 of file IoTree.h.

readTree() [1/2]

std::unique_ptr< Tree > bpp::AbstractITree::readTree ( const std::string &  path ) const

inlineoverridevirtual

Read a tree from a file.

Parameters

path	The file path.

Returns

A new tree object.

Exceptions

Exception

If an error occurred.

Implements bpp::ITree.

Definition at line 201 of file IoTree.h.

References readTree().

readTree() [2/2]

std::unique_ptr< Tree > bpp::AbstractITree::readTree ( std::istream &  in ) const

inlineoverridevirtual

Read a tree from a stream.

Parameters

in	The input stream.

Returns

A new tree object.

Exceptions

Exception

If an error occurred.

Implements bpp::ITree.

Definition at line 195 of file IoTree.h.

References readTreeTemplate().

Referenced by readTree().

readTreeTemplate() [1/2]

virtual std::unique_ptr< TreeTemplate< Node > > bpp::AbstractITree::readTreeTemplate ( const std::string &  path ) const

inlinevirtual

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

Definition at line 211 of file IoTree.h.

References readTreeTemplate().

readTreeTemplate() [2/2]

virtual std::unique_ptr< TreeTemplate< Node > > bpp::AbstractITree::readTreeTemplate ( std::istream &  in ) const

pure virtual

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

Referenced by readTree(), and readTreeTemplate().

---

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

• Bpp/Phyl/Io/IoTree.h