bpp-phyl  2.2.0
bpp::UnrootedTreeException Class Reference

Exception thrown when a tree is expected to be rooted. More...

#include <Bpp/Phyl/TreeExceptions.h>

+ Inheritance diagram for bpp::UnrootedTreeException:
+ Collaboration diagram for bpp::UnrootedTreeException:

Public Member Functions

 UnrootedTreeException (const std::string &text, const Tree *tree=0)
 Build a new UnrootedTreeException. More...
 
virtual ~UnrootedTreeException () throw ()
 
virtual const TreegetTree () const
 Get the tree that threw the exception. More...
 

Detailed Description

Exception thrown when a tree is expected to be rooted.

Definition at line 263 of file TreeExceptions.h.

Constructor & Destructor Documentation

◆ UnrootedTreeException()

UnrootedTreeException::UnrootedTreeException ( const std::string &  text,
const Tree tree = 0 
)

Build a new UnrootedTreeException.

Parameters
textA message to be passed to the exception hierarchy.
treeA const pointer toward the tree that threw the exception.

Definition at line 74 of file TreeExceptions.cpp.

◆ ~UnrootedTreeException()

virtual bpp::UnrootedTreeException::~UnrootedTreeException ( )
throw (
)
inlinevirtual

Definition at line 275 of file TreeExceptions.h.

Member Function Documentation

◆ getTree()

virtual const Tree* bpp::TreeException::getTree ( ) const
inlinevirtualinherited

Get the tree that threw the exception.

Returns
The faulty tree

Definition at line 257 of file TreeExceptions.h.

References bpp::TreeException::tree_.


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