bpp::SiteException Class Reference

The site exception base class. More...

#include <Bpp/Seq/SiteExceptions.h>

Inheritance diagram for bpp::SiteException:

Collaboration diagram for bpp::SiteException:

Public Member Functions
	SiteException (const std::string &text, const CoreSiteInterface *s)
	Build a new SiteException object. More...
	SiteException (const SiteException &se)
SiteException &	operator= (const SiteException &se)
virtual	~SiteException ()
virtual const CoreSiteInterface *	getSite () const
	Get the site that threw the exception. More...
const char *	what () const noexcept override
const std::string &	message () const noexcept

Private Attributes
const CoreSiteInterface *	site_
	A reference toward a site object. More...
std::string	message_

Detailed Description

The site exception base class.

See also

Exception

Definition at line 19 of file SiteExceptions.h.

Constructor & Destructor Documentation

SiteException() [1/2]

bpp::SiteException::SiteException ( const std::string &  text, const CoreSiteInterface *  s  )

inline

Build a new SiteException object.

Parameters

text	A message to be passed to the exception hierarchy.
s	A const reference toward the site that threw the exception.

Definition at line 37 of file SiteExceptions.h.

References toString().

SiteException() [2/2]

bpp::SiteException::SiteException ( const SiteException &  se )

inline

Definition at line 42 of file SiteExceptions.h.

~SiteException()

virtual bpp::SiteException::~SiteException ( )

inlinevirtual

Definition at line 55 of file SiteExceptions.h.

Member Function Documentation

getSite()

virtual const CoreSiteInterface* bpp::SiteException::getSite ( ) const

inlinevirtual

Get the site that threw the exception.

Returns

A const reference toward the site.

Definition at line 63 of file SiteExceptions.h.

References site_.

operator=()

SiteException& bpp::SiteException::operator= ( const SiteException &  se )

inline

Definition at line 47 of file SiteExceptions.h.

References site_.

Member Data Documentation

site_

const CoreSiteInterface* bpp::SiteException::site_

private

A reference toward a site object.

Definition at line 26 of file SiteExceptions.h.

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

---

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

• Bpp/Seq/SiteExceptions.h