bpp-seq3  3.0.0
bpp::AlphabetException Class Reference

The alphabet exception base class. More...

#include <Bpp/Seq/Alphabet/AlphabetExceptions.h>

+ Inheritance diagram for bpp::AlphabetException:
+ Collaboration diagram for bpp::AlphabetException:

Public Member Functions

 AlphabetException (const std::string &text, const Alphabet *alpha)
 Build a new AlphabetException object. More...
 
 AlphabetException (const std::string &text, std::shared_ptr< const Alphabet > alpha)
 Build a new AlphabetException object. More...
 
 AlphabetException (const AlphabetException &ae)
 
AlphabetExceptionoperator= (const AlphabetException &ae)
 
virtual ~AlphabetException ()
 
virtual const AlphabetgetAlphabet () const
 Get the alphabet that threw the exception. More...
 
const char * what () const noexcept override
 
const std::string & message () const noexcept
 

Private Attributes

const Alphabetalphabet_
 
std::string message_
 

Detailed Description

The alphabet exception base class.

See also
Alphabet, Exception

Definition at line 22 of file AlphabetExceptions.h.

Constructor & Destructor Documentation

◆ AlphabetException() [1/3]

AlphabetException::AlphabetException ( const std::string &  text,
const Alphabet alpha 
)

Build a new AlphabetException object.

Parameters
textA message to be passed to the exception hierarchy.
alphaA const pointer toward the alphabet that threw the exception.

Definition at line 18 of file AlphabetExceptions.cpp.

◆ AlphabetException() [2/3]

AlphabetException::AlphabetException ( const std::string &  text,
std::shared_ptr< const Alphabet alpha 
)

Build a new AlphabetException object.

Parameters
textA message to be passed to the exception hierarchy.
alphaA const pointer toward the alphabet that threw the exception.

Definition at line 22 of file AlphabetExceptions.cpp.

◆ AlphabetException() [3/3]

bpp::AlphabetException::AlphabetException ( const AlphabetException ae)
inline

Definition at line 45 of file AlphabetExceptions.h.

◆ ~AlphabetException()

virtual bpp::AlphabetException::~AlphabetException ( )
inlinevirtual

Definition at line 57 of file AlphabetExceptions.h.

Member Function Documentation

◆ getAlphabet()

virtual const Alphabet* bpp::AlphabetException::getAlphabet ( ) const
inlinevirtual

Get the alphabet that threw the exception.

Returns
a const pointer toward the alphabet.

Definition at line 65 of file AlphabetExceptions.h.

References alphabet_.

◆ operator=()

AlphabetException& bpp::AlphabetException::operator= ( const AlphabetException ae)
inline

Definition at line 50 of file AlphabetExceptions.h.

References alphabet_.

Member Data Documentation

◆ alphabet_

const Alphabet* bpp::AlphabetException::alphabet_
private

Definition at line 26 of file AlphabetExceptions.h.

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


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