bpp-phyl3  3.0.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
bpp::PhyloTreeException Class Reference

General exception thrown when something wrong happened in a tree. More...

#include <Bpp/Phyl/Tree/PhyloTreeExceptions.h>

+ Inheritance diagram for bpp::PhyloTreeException:
+ Collaboration diagram for bpp::PhyloTreeException:

Public Member Functions

 PhyloTreeException (const std::string &text, const PhyloTree *tree=0)
 Build a new PhyloTreeException. More...
 
 PhyloTreeException (const PhyloTreeException &tex)
 
PhyloTreeExceptionoperator= (const PhyloTreeException &tex)
 
virtual ~PhyloTreeException ()
 
virtual const PhyloTreegetTree () const
 Get the tree that threw the exception. More...
 
const char * what () const noexcept override
 
const std::string & message () const noexcept
 

Private Attributes

const PhyloTreetree_
 
std::string message_
 

Detailed Description

General exception thrown when something wrong happened in a tree.

Definition at line 393 of file PhyloTreeExceptions.h.

Constructor & Destructor Documentation

◆ PhyloTreeException() [1/2]

PhyloTreeException::PhyloTreeException ( const std::string &  text,
const PhyloTree tree = 0 
)

Build a new PhyloTreeException.

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

Definition at line 63 of file PhyloTreeExceptions.cpp.

◆ PhyloTreeException() [2/2]

bpp::PhyloTreeException::PhyloTreeException ( const PhyloTreeException tex)
inline

Definition at line 408 of file PhyloTreeExceptions.h.

◆ ~PhyloTreeException()

virtual bpp::PhyloTreeException::~PhyloTreeException ( )
inlinevirtual

Definition at line 420 of file PhyloTreeExceptions.h.

Member Function Documentation

◆ getTree()

virtual const PhyloTree* bpp::PhyloTreeException::getTree ( ) const
inlinevirtual

Get the tree that threw the exception.

Returns
The faulty tree

Definition at line 428 of file PhyloTreeExceptions.h.

References tree_.

◆ operator=()

PhyloTreeException& bpp::PhyloTreeException::operator= ( const PhyloTreeException tex)
inline

Definition at line 413 of file PhyloTreeExceptions.h.

References tree_.

Member Data Documentation

◆ tree_

const PhyloTree* bpp::PhyloTreeException::tree_
private

Definition at line 397 of file PhyloTreeExceptions.h.

Referenced by getTree(), and operator=().


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