bpp::PhyloNodeException Class Reference

General exception thrown when something is wrong with a particular node. More...

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

Inheritance diagram for bpp::PhyloNodeException:

Collaboration diagram for bpp::PhyloNodeException:

Public Member Functions
	PhyloNodeException (const std::string &text, uint nodeId)
	Build a new PhyloNodeException. More...
virtual	~PhyloNodeException ()
virtual uint	getNodeId () const
	Get the id of node that threw the exception. More...
const char *	what () const noexcept override
const std::string &	message () const noexcept

Protected Attributes
uint	nodeId_

Private Attributes
std::string	message_

Detailed Description

General exception thrown when something is wrong with a particular node.

Definition at line 25 of file PhyloTreeExceptions.h.

Constructor & Destructor Documentation

PhyloNodeException()

bpp::PhyloNodeException::PhyloNodeException ( const std::string &  text, uint  nodeId  )

inline

Build a new PhyloNodeException.

Parameters

text	A message to be passed to the exception hierarchy.
nodeId	The id of the node that threw the exception.

Definition at line 37 of file PhyloTreeExceptions.h.

References toString().

~PhyloNodeException()

virtual bpp::PhyloNodeException::~PhyloNodeException ( )

inlinevirtual

Definition at line 41 of file PhyloTreeExceptions.h.

Member Function Documentation

getNodeId()

virtual uint bpp::PhyloNodeException::getNodeId ( ) const

inlinevirtual

Get the id of node that threw the exception.

Returns

The id of the faulty node.

Reimplemented in bpp::PhyloNodePException.

Definition at line 49 of file PhyloTreeExceptions.h.

References nodeId_.

Member Data Documentation

nodeId_

uint bpp::PhyloNodeException::nodeId_

protected

Definition at line 29 of file PhyloTreeExceptions.h.

Referenced by getNodeId(), and bpp::PhyloNodePException::getNodeId().

---

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

• Bpp/Phyl/Tree/PhyloTreeExceptions.h