bpp-phyl  2.2.0
bpp::AbstractITree Class Referenceabstract

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 ()
 
virtual Treeread (std::istream &in) const =0 throw (Exception)
 Read a tree from a stream. More...
 
virtual Treeread (const std::string &path) const throw (Exception)
 Read a tree from a file. More...
 
virtual const std::string getDataType () const
 

Detailed Description

Partial implementation of the ITree interface.

Definition at line 134 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractITree()

bpp::AbstractITree::AbstractITree ( )
inline

Definition at line 138 of file IoTree.h.

◆ ~AbstractITree()

virtual bpp::AbstractITree::~AbstractITree ( )
inlinevirtual

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

◆ read() [1/2]

virtual Tree* bpp::AbstractITree::read ( std::istream &  in) const
throw (Exception
)
pure virtual

Read a tree from a stream.

Parameters
inThe input stream.
Returns
A new tree object.
Exceptions
ExceptionIf an error occured.

Implements bpp::ITree.

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

Referenced by bpp::NexusIOTree::read(), bpp::Newick::read(), read(), and bpp::Nhx::read().

◆ read() [2/2]

virtual Tree* bpp::AbstractITree::read ( const std::string &  path) const
throw (Exception
)
inlinevirtual

Read a tree from a file.

Parameters
pathThe file path.
Returns
A new tree object.
Exceptions
ExceptionIf an error occured.

Implements bpp::ITree.

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

Definition at line 143 of file IoTree.h.

References read().


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