bpp-seq  2.2.0
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 Site *s=0)
 Build a new SiteException object. More...
 
 SiteException (const SiteException &se)
 
SiteExceptionoperator= (const SiteException &se)
 
virtual ~SiteException () throw ()
 
virtual const SitegetSite () const
 Get the site that threw the exception. More...
 

Private Attributes

const Sitesite_
 A pointer toward a site object. More...
 

Detailed Description

The site exception base class.

See also
Exception

Definition at line 55 of file SiteExceptions.h.

Constructor & Destructor Documentation

◆ SiteException() [1/2]

SiteException::SiteException ( const std::string &  text,
const Site s = 0 
)

Build a new SiteException object.

Parameters
textA message to be passed to the exception hierarchy.
sA const pointer toward the site that threw the exception.

Definition at line 47 of file SiteExceptions.cpp.

◆ SiteException() [2/2]

bpp::SiteException::SiteException ( const SiteException se)
inline

Definition at line 75 of file SiteExceptions.h.

◆ ~SiteException()

virtual bpp::SiteException::~SiteException ( )
throw (
)
inlinevirtual

Definition at line 85 of file SiteExceptions.h.

Member Function Documentation

◆ getSite()

virtual const Site* bpp::SiteException::getSite ( ) const
inlinevirtual

Get the site that threw the exception.

Returns
A const pointer toward the site.

Definition at line 94 of file SiteExceptions.h.

References site_.

◆ operator=()

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

Definition at line 77 of file SiteExceptions.h.

References site_.

Member Data Documentation

◆ site_

const Site* bpp::SiteException::site_
private

A pointer toward a site object.

Definition at line 63 of file SiteExceptions.h.

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


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