bpp::UnrootedPhyloTreeException Class Reference
Exception thrown when a tree is expected to be rooted. More...
#include <Bpp/Phyl/Tree/PhyloTreeExceptions.h>
Inheritance diagram for bpp::UnrootedPhyloTreeException:
Collaboration diagram for bpp::UnrootedPhyloTreeException:
Public Member Functions | |
| UnrootedPhyloTreeException (const std::string &text, const PhyloTree *tree=0) | |
| Build a new UnrootedPhyloTreeException. More... | |
| virtual | ~UnrootedPhyloTreeException () |
| virtual const PhyloTree * | getTree () const |
| Get the tree that threw the exception. More... | |
| const char * | what () const noexcept override |
| const std::string & | message () const noexcept |
Private Attributes | |
| const PhyloTree * | tree_ |
| std::string | message_ |
Detailed Description
Exception thrown when a tree is expected to be rooted.
Definition at line 434 of file PhyloTreeExceptions.h.
Constructor & Destructor Documentation
◆ UnrootedPhyloTreeException()
| UnrootedPhyloTreeException::UnrootedPhyloTreeException | ( | const std::string & | text, |
| const PhyloTree * | tree = 0 |
||
| ) |
Build a new UnrootedPhyloTreeException.
- Parameters
-
text A message to be passed to the exception hierarchy. tree A const pointer toward the tree that threw the exception.
Definition at line 69 of file PhyloTreeExceptions.cpp.
◆ ~UnrootedPhyloTreeException()
|
inlinevirtual |
Definition at line 446 of file PhyloTreeExceptions.h.
Member Function Documentation
◆ getTree()
|
inlinevirtualinherited |
Get the tree that threw the exception.
- Returns
- The faulty tree
Definition at line 428 of file PhyloTreeExceptions.h.
References bpp::PhyloTreeException::tree_.
Member Data Documentation
◆ tree_
|
privateinherited |
Definition at line 397 of file PhyloTreeExceptions.h.
Referenced by bpp::PhyloTreeException::getTree(), and bpp::PhyloTreeException::operator=().
The documentation for this class was generated from the following files:
- Bpp/Phyl/Tree/PhyloTreeExceptions.h
- Bpp/Phyl/Tree/PhyloTreeExceptions.cpp
