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:

List of all members.

Public Member Functions
	AlphabetException (const std::string &text, const Alphabet *alpha=0)
	Build a new AlphabetException object.
	AlphabetException (const AlphabetException &ae)
AlphabetException &	operator= (const AlphabetException &ae)
virtual	~AlphabetException () throw ()
virtual const Alphabet *	getAlphabet () const
	Get the alphabet that threw the exception.
const char *	what () const
Protected Attributes
std::string	message_
Private Attributes
const Alphabet *	alphabet_

---

Detailed Description

The alphabet exception base class.

See also:

Alphabet, Exception

Definition at line 58 of file AlphabetExceptions.h.

---

Constructor & Destructor Documentation

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

Build a new AlphabetException object.

Parameters:

text	A message to be passed to the exception hierarchy.
alpha	A const pointer toward the alphabet that threw the exception.

Definition at line 52 of file AlphabetExceptions.cpp.

bpp::AlphabetException::AlphabetException

(

const AlphabetException &

ae

)

[inline]

Definition at line 73 of file AlphabetExceptions.h.

virtual bpp::AlphabetException::~AlphabetException

(

)

throw () [inline, virtual]

Definition at line 81 of file AlphabetExceptions.h.

---

Member Function Documentation

virtual const Alphabet* bpp::AlphabetException::getAlphabet

(

)

const [inline, virtual]

Get the alphabet that threw the exception.

Returns:

a const pointer toward the alphabet.

Definition at line 89 of file AlphabetExceptions.h.

References alphabet_.

AlphabetException& bpp::AlphabetException::operator=

(

const AlphabetException &

ae

)

[inline]

Definition at line 74 of file AlphabetExceptions.h.

References alphabet_.

---

Member Data Documentation

const Alphabet* bpp::AlphabetException::alphabet_ [private]

Definition at line 62 of file AlphabetExceptions.h.

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

---

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

• Bpp/Seq/Alphabet/AlphabetExceptions.h
• Bpp/Seq/Alphabet/AlphabetExceptions.cpp