Search Toolkit Book for CSearchMessage

Error or Warning Message from search. More...

#include <algo/blast/api/blast_types.hpp>

Inheritance diagram for CSearchMessage:

Collaboration diagram for CSearchMessage:

Public Member Functions
	CSearchMessage (EBlastSeverity severity, int error_id, const string &message)
	Construct a search message object. More...

	CSearchMessage ()
	Construct an empty search message object. More...

EBlastSeverity	GetSeverity () const
	Get the severity of this message. More...

void	SetSeverity (EBlastSeverity sev)
	Adjust the severity of this message. More...

string	GetSeverityString () const
	Get the severity of this message as a string. More...

int	GetErrorId () const
	Get the error identifier. More...

string &	SetMessage (void)
	Set the error message. More...

string	GetMessage (bool withSeverity=true) const
	Get the error message. More...

bool	operator== (const CSearchMessage &rhs) const
	Compare two error messages for equality. More...

bool	operator!= (const CSearchMessage &rhs) const
	Compare two error messages for inequality. More...

bool	operator< (const CSearchMessage &rhs) const
	Compare two error messages for order. More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Static Public Member Functions
static string	GetSeverityString (EBlastSeverity severity)
	Get the symbolic name for a level of severity as a string. More...

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Private Attributes
EBlastSeverity	m_Severity
	The severity of this error or warning message. More...

int	m_ErrorId
	A unique identifier specifying what kind of error this is. More...

string	m_Message
	A message describing the error to the application user. More...

Additional Inherited Members
Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

Error or Warning Message from search.

This class encapsulates a single error or warning message returned from a search. These include conditions detected by the algorithm where no exception is thrown, but which impact the completeness or accuracy of search results. One example might be a completely masked query.

Definition at line 116 of file blast_types.hpp.

Constructor & Destructor Documentation

◆ CSearchMessage() [1/2]

CSearchMessage::CSearchMessage	(	EBlastSeverity	severity,
		int	error_id,
		const string &	message
	)

inline

Construct a search message object.

Parameters

severity	The severity of this message. [in]
error_id	A number unique to this error. [in]
message	A description of the error for the user. [in]

Definition at line 122 of file blast_types.hpp.

◆ CSearchMessage() [2/2]

CSearchMessage::CSearchMessage ( )

inline

Construct an empty search message object.

Definition at line 130 of file blast_types.hpp.

Member Function Documentation

◆ GetErrorId()

int CSearchMessage::GetErrorId ( ) const

inline

Get the error identifier.

Returns: An identifier unique to this specific message.

Definition at line 169 of file blast_types.hpp.

References m_ErrorId.

◆ GetMessage()

string CSearchMessage::GetMessage ( bool withSeverity = true ) const

inline

Get the error message.

Returns: A message describing this error or warning.

Definition at line 180 of file blast_types.hpp.

References GetSeverityString(), and m_Message.

◆ GetSeverity()

EBlastSeverity CSearchMessage::GetSeverity ( ) const

inline

Get the severity of this message.

Returns: The severity of this message.

Definition at line 137 of file blast_types.hpp.

References m_Severity.

◆ GetSeverityString() [1/2]

string CSearchMessage::GetSeverityString ( ) const

inline

Get the severity of this message as a string.

Returns: A symbolic name for the severity level (such as "Warning").

Definition at line 148 of file blast_types.hpp.

References m_Severity.

Referenced by GetMessage().

◆ GetSeverityString() [2/2]

static string CSearchMessage::GetSeverityString ( EBlastSeverity severity )

inlinestatic

Get the symbolic name for a level of severity as a string.

Parameters

severity The severity as an enumeration.

Returns: A symbolic name for the severity level (such as "Warning").

Definition at line 156 of file blast_types.hpp.

References eBlastSevError, eBlastSevFatal, eBlastSevInfo, and eBlastSevWarning.

◆ operator!=()

bool CSearchMessage::operator!= ( const CSearchMessage & rhs ) const

inline

Compare two error messages for inequality.

Returns: True if the messages are not the same.

Definition at line 289 of file blast_types.hpp.

◆ operator<()

bool CSearchMessage::operator< ( const CSearchMessage & rhs ) const

inline

Compare two error messages for order.

Returns: True if the first message is less than the second.

Definition at line 294 of file blast_types.hpp.

References m_ErrorId, m_Message, and m_Severity.

◆ operator==()

bool CSearchMessage::operator== ( const CSearchMessage & rhs ) const

inline

Compare two error messages for equality.

Returns: True if the messages are the same.

Definition at line 277 of file blast_types.hpp.

References m_ErrorId, m_Message, and m_Severity.

◆ SetMessage()

string& CSearchMessage::SetMessage ( void )

inline

Set the error message.

Returns: A reference allowing the user to set the error string.

Definition at line 176 of file blast_types.hpp.

References m_Message.

◆ SetSeverity()

void CSearchMessage::SetSeverity ( EBlastSeverity sev )

inline

Adjust the severity of this message.

Parameters

sev	The severity to assign. [in]

Definition at line 144 of file blast_types.hpp.

References m_Severity.

Member Data Documentation

◆ m_ErrorId

int CSearchMessage::m_ErrorId

private

A unique identifier specifying what kind of error this is.

Definition at line 205 of file blast_types.hpp.

Referenced by GetErrorId(), operator<(), and operator==().

◆ m_Message

string CSearchMessage::m_Message

private

A message describing the error to the application user.

Definition at line 208 of file blast_types.hpp.

Referenced by GetMessage(), operator<(), operator==(), and SetMessage().

◆ m_Severity

EBlastSeverity CSearchMessage::m_Severity

private

The severity of this error or warning message.

Definition at line 202 of file blast_types.hpp.

Referenced by GetSeverity(), GetSeverityString(), operator<(), operator==(), and SetSeverity().

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

include/algo/blast/api/blast_types.hpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSearchMessage() [1/2]

◆ CSearchMessage() [2/2]

Member Function Documentation

◆ GetErrorId()

◆ GetMessage()

◆ GetSeverity()

◆ GetSeverityString() [1/2]

◆ GetSeverityString() [2/2]

◆ operator!=()

◆ operator<()

◆ operator==()

◆ SetMessage()

◆ SetSeverity()

Member Data Documentation

◆ m_ErrorId

◆ m_Message

◆ m_Severity