NCBI C++ ToolKit
Public Types | Public Member Functions | Private Attributes | List of all members
CAlnError Class Reference

Search Toolkit Book for CAlnError

#include <objtools/readers/aln_reader.hpp>

Public Types

enum  EAlnErr {
  eAlnErr_Unknown = -1 , eAlnErr_NoError = 0 , eAlnErr_Fatal , eAlnErr_BadData ,
  eAlnErr_BadFormat , eAlnErr_BadChar
}
 

Public Member Functions

 CAlnError (int category, int line_num, string id, string message)
 
 CAlnError (const CAlnError &e)
 Copy constructor. More...
 
 ~CAlnError ()
 
EAlnErr GetCategory () const
 
int GetLineNum () const
 
const stringGetID () const
 
const stringGetMsg () const
 
const stringGetMessage () const
 

Private Attributes

EAlnErr m_Category
 
int m_LineNum
 
string m_ID
 
string m_Message
 

Detailed Description

Definition at line 55 of file aln_reader.hpp.

Member Enumeration Documentation

◆ EAlnErr

Enumerator
eAlnErr_Unknown 
eAlnErr_NoError 
eAlnErr_Fatal 
eAlnErr_BadData 
eAlnErr_BadFormat 
eAlnErr_BadChar 

Definition at line 60 of file aln_reader.hpp.

Constructor & Destructor Documentation

◆ CAlnError() [1/2]

CAlnError::CAlnError ( int  category,
int  line_num,
string  id,
string  message 
)

◆ CAlnError() [2/2]

CAlnError::CAlnError ( const CAlnError e)

Copy constructor.

Definition at line 112 of file aln_reader.cpp.

References GetCategory(), GetID(), GetLineNum(), GetMsg(), m_Category, m_ID, m_LineNum, and m_Message.

◆ ~CAlnError()

CAlnError::~CAlnError ( )
inline

Definition at line 76 of file aln_reader.hpp.

Member Function Documentation

◆ GetCategory()

EAlnErr CAlnError::GetCategory ( void  ) const
inline

Definition at line 79 of file aln_reader.hpp.

References m_Category.

Referenced by CAlnError().

◆ GetID()

const string& CAlnError::GetID ( void  ) const
inline

Definition at line 81 of file aln_reader.hpp.

References m_ID.

Referenced by CAlnError().

◆ GetLineNum()

int CAlnError::GetLineNum ( void  ) const
inline

Definition at line 80 of file aln_reader.hpp.

References m_LineNum.

Referenced by CAlnError().

◆ GetMessage()

const string& CAlnError::GetMessage ( void  ) const
inline
Deprecated:
Use GetMsg() instead - to avoid conflict with Windows macro

Definition at line 86 of file aln_reader.hpp.

References m_Message.

◆ GetMsg()

const string& CAlnError::GetMsg ( void  ) const
inline

Definition at line 82 of file aln_reader.hpp.

References m_Message.

Referenced by CAlnError().

Member Data Documentation

◆ m_Category

EAlnErr CAlnError::m_Category
private

Definition at line 89 of file aln_reader.hpp.

Referenced by CAlnError(), and GetCategory().

◆ m_ID

string CAlnError::m_ID
private

Definition at line 91 of file aln_reader.hpp.

Referenced by CAlnError(), and GetID().

◆ m_LineNum

int CAlnError::m_LineNum
private

Definition at line 90 of file aln_reader.hpp.

Referenced by CAlnError(), and GetLineNum().

◆ m_Message

string CAlnError::m_Message
private

Definition at line 92 of file aln_reader.hpp.

Referenced by CAlnError(), GetMessage(), and GetMsg().


The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:25:08 2024 by modify_doxy.py rev. 669887