bpp-seq3  3.0.0
bpp::SiteNotFoundException Class Reference

The site not found exception base class. More...

#include <Bpp/Seq/Container/SiteContainerExceptions.h>

+ Inheritance diagram for bpp::SiteNotFoundException:
+ Collaboration diagram for bpp::SiteNotFoundException:

Public Member Functions

 SiteNotFoundException (const char *text, const char *sId="")
 Build a new SiteNotFoundException object. More...
 
 SiteNotFoundException (const std::string &text, const std::string &sId="")
 Build a new SiteNotFoundException object. More...
 
 ~SiteNotFoundException ()
 
virtual const std::string getSiteId () const
 Get the id of the site that was to be found. More...
 
const char * what () const noexcept override
 
const std::string & message () const noexcept
 

Protected Attributes

const std::string id
 The id of the site that was to be found. More...
 

Private Attributes

std::string message_
 

Detailed Description

The site not found exception base class.

See also
Exception

Definition at line 20 of file SiteContainerExceptions.h.

Constructor & Destructor Documentation

◆ SiteNotFoundException() [1/2]

SiteNotFoundException::SiteNotFoundException ( const char *  text,
const char *  sId = "" 
)

Build a new SiteNotFoundException object.

Parameters
textA message to be passed to the exception hierarchy.
sIdA the id of the site that was to be found.

Definition at line 14 of file SiteContainerExceptions.cpp.

◆ SiteNotFoundException() [2/2]

SiteNotFoundException::SiteNotFoundException ( const std::string &  text,
const std::string &  sId = "" 
)

Build a new SiteNotFoundException object.

Parameters
textA message to be passed to the exception hierarchy.
sIdA the id of the site that was to be found.

Definition at line 18 of file SiteContainerExceptions.cpp.

◆ ~SiteNotFoundException()

SiteNotFoundException::~SiteNotFoundException ( )

Definition at line 22 of file SiteContainerExceptions.cpp.

Member Function Documentation

◆ getSiteId()

const string SiteNotFoundException::getSiteId ( ) const
virtual

Get the id of the site that was to be found.

Returns
The id of the site that was to be found.

Definition at line 24 of file SiteContainerExceptions.cpp.

References id.

Member Data Documentation

◆ id

const std::string bpp::SiteNotFoundException::id
protected

The id of the site that was to be found.

Definition at line 27 of file SiteContainerExceptions.h.

Referenced by getSiteId().


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