bpp-phyl  2.2.0
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 ()
 
void write (const std::vector< Tree *> &trees, std::ostream &out) const =0 throw (Exception)
 Write trees to a stream. More...
 
virtual void write (const std::vector< Tree *> &trees, const std::string &path, bool overwrite) const throw (Exception)
 Write trees to a file. More...
 
virtual const std::string getDataType () const
 

Detailed Description

Partial implementation of the OTree interface.

Definition at line 274 of file IoTree.h.

Constructor & Destructor Documentation

◆ AbstractOMultiTree()

bpp::AbstractOMultiTree::AbstractOMultiTree ( )
inline

Definition at line 278 of file IoTree.h.

◆ ~AbstractOMultiTree()

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

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

◆ write() [1/2]

void bpp::AbstractOMultiTree::write ( const std::vector< Tree *> &  trees,
std::ostream &  out 
) const
throw (Exception
)
pure virtual

Write trees to a stream.

Parameters
treesA vector of tree objects.
outThe output stream.
Exceptions
ExceptionIf an error occured.

Implements bpp::OMultiTree.

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

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

◆ write() [2/2]

virtual void bpp::AbstractOMultiTree::write ( const std::vector< Tree *> &  trees,
const std::string &  path,
bool  overwrite 
) const
throw (Exception
)
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 occured.

Implements bpp::OMultiTree.

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

Definition at line 283 of file IoTree.h.

References write().


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