bpp-seq  2.2.0
bpp::SequenceException Class Reference

The sequence exception base class. More...

#include <Bpp/Seq/SequenceExceptions.h>

+ Inheritance diagram for bpp::SequenceException:
+ Collaboration diagram for bpp::SequenceException:

Public Member Functions

 SequenceException (const std::string &text, const Sequence *seq=0)
 Build a new SequenceException object. More...
 
 SequenceException (const SequenceException &se)
 
SequenceExceptionoperator= (const SequenceException &se)
 
virtual ~SequenceException () throw ()
 
virtual const SequencegetSequence () const
 Get the sequence that threw the exception. More...
 

Private Attributes

const Sequencesequence_
 A pointer toward a sequence object. More...
 

Detailed Description

The sequence exception base class.

See also
Exception

Definition at line 56 of file SequenceExceptions.h.

Constructor & Destructor Documentation

◆ SequenceException() [1/2]

SequenceException::SequenceException ( const std::string &  text,
const Sequence seq = 0 
)

Build a new SequenceException object.

Parameters
textA message to be passed to the exception hierarchy.
seqA const pointer toward the sequence that threw the exception.

Definition at line 48 of file SequenceExceptions.cpp.

◆ SequenceException() [2/2]

bpp::SequenceException::SequenceException ( const SequenceException se)
inline

Definition at line 76 of file SequenceExceptions.h.

◆ ~SequenceException()

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

Definition at line 84 of file SequenceExceptions.h.

Member Function Documentation

◆ getSequence()

virtual const Sequence* bpp::SequenceException::getSequence ( ) const
inlinevirtual

Get the sequence that threw the exception.

Returns
A const pointer toward the sequence.

Definition at line 93 of file SequenceExceptions.h.

References sequence_.

◆ operator=()

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

Definition at line 77 of file SequenceExceptions.h.

References sequence_.

Member Data Documentation

◆ sequence_

const Sequence* bpp::SequenceException::sequence_
private

A pointer toward a sequence object.

Definition at line 64 of file SequenceExceptions.h.

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


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