bpp::PhyloBranchException Class Reference
General exception thrown when something is wrong with a particular branch. More...
#include <Bpp/Phyl/Tree/PhyloTreeExceptions.h>
Inheritance diagram for bpp::PhyloBranchException:
Collaboration diagram for bpp::PhyloBranchException:
Public Member Functions | |
| PhyloBranchException (const std::string &text, uint branchId) | |
| Build a new PhyloBranchPException. More... | |
| virtual | ~PhyloBranchException () |
| virtual uint | getBranchId () const |
| Get the id of branch that threw the exception. More... | |
| const char * | what () const noexcept override |
| const std::string & | message () const noexcept |
Protected Attributes | |
| uint | branchId_ |
Private Attributes | |
| std::string | message_ |
Detailed Description
General exception thrown when something is wrong with a particular branch.
Definition at line 208 of file PhyloTreeExceptions.h.
Constructor & Destructor Documentation
◆ PhyloBranchException()
|
inline |
Build a new PhyloBranchPException.
- Parameters
-
text A message to be passed to the exception hierarchy. branchId The id of the branch that threw the exception.
Definition at line 220 of file PhyloTreeExceptions.h.
References toString().
◆ ~PhyloBranchException()
|
inlinevirtual |
Definition at line 224 of file PhyloTreeExceptions.h.
Member Function Documentation
◆ getBranchId()
|
inlinevirtual |
Get the id of branch that threw the exception.
- Returns
- The id of the faulty branch.
Reimplemented in bpp::PhyloBranchPException.
Definition at line 232 of file PhyloTreeExceptions.h.
References branchId_.
Member Data Documentation
◆ branchId_
|
protected |
Definition at line 212 of file PhyloTreeExceptions.h.
Referenced by getBranchId(), and bpp::PhyloBranchPException::getBranchId().
The documentation for this class was generated from the following file:
- Bpp/Phyl/Tree/PhyloTreeExceptions.h
