bpp-seq3  3.0.0
bpp::SiteWithGapException Class Reference

Exception sent when a site containing gap is found. More...

#include <Bpp/Seq/SiteExceptions.h>

+ Inheritance diagram for bpp::SiteWithGapException:
+ Collaboration diagram for bpp::SiteWithGapException:

Public Member Functions

 SiteWithGapException (const std::string &text, const CoreSiteInterface *s)
 
virtual ~SiteWithGapException ()
 
virtual const CoreSiteInterfacegetSite () const
 Get the site that threw the exception. More...
 
const char * what () const noexcept override
 
const std::string & message () const noexcept
 

Private Attributes

const CoreSiteInterfacesite_
 A reference toward a site object. More...
 
std::string message_
 

Detailed Description

Exception sent when a site containing gap is found.

Definition at line 82 of file SiteExceptions.h.

Constructor & Destructor Documentation

◆ SiteWithGapException()

bpp::SiteWithGapException::SiteWithGapException ( const std::string &  text,
const CoreSiteInterface s 
)
inline

Definition at line 86 of file SiteExceptions.h.

◆ ~SiteWithGapException()

virtual bpp::SiteWithGapException::~SiteWithGapException ( )
inlinevirtual

Definition at line 89 of file SiteExceptions.h.

Member Function Documentation

◆ getSite()

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

Get the site that threw the exception.

Returns
A const reference toward the site.

Definition at line 63 of file SiteExceptions.h.

References bpp::SiteException::site_.

Member Data Documentation

◆ site_

const CoreSiteInterface* bpp::SiteException::site_
privateinherited

A reference toward a site object.

Definition at line 26 of file SiteExceptions.h.

Referenced by bpp::SiteException::getSite(), and bpp::SiteException::operator=().


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