CBlastException Class Reference
[BLAST (Basic Local Alignment Search Tool)]

Search Toolkit Book for CBlastException

#include <blast_exception.hpp>

Inheritance diagram for CBlastException:

[legend]Collaboration diagram for CBlastException:

[legend]List of all members.

---

Detailed Description

Defines BLAST error codes (user errors included).

Definition at line 69 of file blast_exception.hpp.

Public Types
enum	EErrCode {   eCoreBlastError, eInvalidOptions, eInvalidArgument, eNotSupported,   eInvalidCharacter, eSeqSrcInit, eRpsInit, eSetup }
	Error types that BLAST can generate. More...
Public Member Functions
virtual const char *	GetErrCodeString (void) const
	Translate from the error code value to its string representation.
	NCBI_EXCEPTION_DEFAULT (CBlastException, CException)

---

Member Enumeration Documentation

enum CBlastException::EErrCode

Error types that BLAST can generate. Enumerator: eCoreBlastError  FIXME: need to interpret CORE errors. eInvalidOptions  Invalid algorithm options. eInvalidArgument  Invalid argument to some function/method (could be programmer error - prefer assertions in those cases unless API needs to be "bullet-proof"). eNotSupported  Feature not supported. eInvalidCharacter  Invalid character in sequence data. eSeqSrcInit  Initialization error in BlastSeqSrc implementation. eRpsInit  Error while initializing RPS-BLAST. eSetup  Error while setting up BLAST. Reimplemented from CException. Reimplemented in CPssmEngineException, and CRemoteBlastException. Definition at line 73 of file blast_exception.hpp.

---

Member Function Documentation

virtual const char* CBlastException::GetErrCodeString (  void   )  const [inline, virtual]

Translate from the error code value to its string representation. Reimplemented from CException. Reimplemented in CPssmEngineException, and CRemoteBlastException. Definition at line 89 of file blast_exception.hpp. References eCoreBlastError, eInvalidArgument, eInvalidCharacter, eInvalidOptions, eNotSupported, eRpsInit, eSeqSrcInit, CException::GetErrCode(), and CException::GetErrCodeString().

CBlastException::NCBI_EXCEPTION_DEFAULT (  CBlastException  , CException  )

---

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

• include/algo/blast/api/blast_exception.hpp

---