bpp-seq3  3.0.0
Public Member Functions | Private Attributes | List of all members
bpp::SequenceNotAlignedException Class Reference

Exception thrown when a sequence is not align with others. More...

#include <Bpp/Seq/SequenceExceptions.h>

+ Inheritance diagram for bpp::SequenceNotAlignedException:
+ Collaboration diagram for bpp::SequenceNotAlignedException:

Public Member Functions

 SequenceNotAlignedException (const std::string &text, const CoreSequenceInterface *seq)
 Build a new SequenceNotAlignedException object. More...
 
virtual ~SequenceNotAlignedException ()
 
virtual const CoreSequenceInterface * getSequence () const
 Get the sequence that threw the exception. More...
 
const char * what () const noexcept override
 
const std::string & message () const noexcept
 

Private Attributes

const CoreSequenceInterface * sequence_
 A pointer toward a sequence object. More...
 
std::string message_
 

Detailed Description

Exception thrown when a sequence is not align with others.

Typically, this may occur when you try to add a bad sequence to a site container.

Definition at line 112 of file SequenceExceptions.h.

Constructor & Destructor Documentation

◆ SequenceNotAlignedException()

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

Build a new SequenceNotAlignedException object.

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

Definition at line 122 of file SequenceExceptions.h.

◆ ~SequenceNotAlignedException()

virtual bpp::SequenceNotAlignedException::~SequenceNotAlignedException ( )
inlinevirtual

Definition at line 126 of file SequenceExceptions.h.

Member Function Documentation

◆ getSequence()

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

Get the sequence that threw the exception.

Returns
A const pointer toward the sequence.

Definition at line 64 of file SequenceExceptions.h.

References bpp::SequenceException::sequence_.

Member Data Documentation

◆ sequence_

const CoreSequenceInterface* bpp::SequenceException::sequence_
privateinherited

A pointer toward a sequence object.

Definition at line 30 of file SequenceExceptions.h.

Referenced by bpp::SequenceException::getSequence(), and bpp::SequenceException::operator=().

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