bpp-seq3  3.0.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 CoreSequenceInterface *seq)
 Build a new SequenceException object. More...
 
 SequenceException (const SequenceException &se)
 
SequenceExceptionoperator= (const SequenceException &se)
 
virtual ~SequenceException ()
 
virtual const CoreSequenceInterfacegetSequence () const
 Get the sequence that threw the exception. More...
 
const char * what () const noexcept override
 
const std::string & message () const noexcept
 

Private Attributes

const CoreSequenceInterfacesequence_
 A pointer toward a sequence object. More...
 
std::string message_
 

Detailed Description

The sequence exception base class.

See also
Exception

Definition at line 23 of file SequenceExceptions.h.

Constructor & Destructor Documentation

◆ SequenceException() [1/2]

bpp::SequenceException::SequenceException ( const std::string &  text,
const CoreSequenceInterface seq 
)
inline

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. The exception object is not managing the pointer.

Definition at line 39 of file SequenceExceptions.h.

◆ SequenceException() [2/2]

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

Definition at line 44 of file SequenceExceptions.h.

◆ ~SequenceException()

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

Definition at line 56 of file SequenceExceptions.h.

Member Function Documentation

◆ getSequence()

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

Get the sequence that threw the exception.

Returns
A const pointer toward the sequence.

Definition at line 64 of file SequenceExceptions.h.

References sequence_.

◆ operator=()

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

Definition at line 49 of file SequenceExceptions.h.

References sequence_.

Member Data Documentation

◆ sequence_

const CoreSequenceInterface* bpp::SequenceException::sequence_
private

A pointer toward a sequence object.

Definition at line 30 of file SequenceExceptions.h.

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


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