NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CLineErrorEx Class Reference

Search Toolkit Book for CLineErrorEx

#include <objtools/readers/line_error.hpp>

+ Inheritance diagram for CLineErrorEx:
+ Collaboration diagram for CLineErrorEx:

Public Member Functions

virtual ILineErrorClone (void) const override
 Use this because copy ctor is protected. More...
 
virtual ~CLineErrorEx (void)
 
void Throw (void) const
 copy constructor is protected so please use this function to throw the object. More...
 
void PatchLineNumber (unsigned int uLine)
 
void AddOtherLine (unsigned int uOtherLine)
 
EProblem Problem (void) const override
 
virtual EDiagSev Severity (void) const override
 
const std::stringSeqId (void) const override
 
unsigned int Line (void) const override
 
const TVecOfLinesOtherLines (void) const override
 
const std::stringFeatureName (void) const override
 
const std::stringQualifierName (void) const override
 
const std::stringQualifierValue (void) const override
 
virtual std::string ProblemStr (void) const override
 
const std::stringErrorMessage (void) const override
 
virtual string Message (void) const override
 
virtual int GetCode (void) const override
 
virtual int GetSubCode (void) const override
 
- Public Member Functions inherited from ILineError
virtual ~ILineError (void) noexcept
 
std::string SeverityStr (void) const
 
virtual void Write (CNcbiOstream &out) const
 
virtual void WriteAsXML (CNcbiOstream &out) const
 
virtual string GetText (void) const
 
virtual EDiagSev GetSeverity (void) const
 
virtual void Dump (CNcbiOstream &out) const
 
virtual std::string Compose (void) const
 
virtual void DumpAsXML (CNcbiOstream &out) const
 
- Public Member Functions inherited from IObjtoolsMessage
virtual ~IObjtoolsMessage (void)=default
 

Static Public Member Functions

static CLineErrorExCreate (EProblem eProblem, EDiagSev eSeverity, int code, int subcode, const std::string &strSeqId, unsigned int uLine, const std::string &strErrorMessage=string(""), const std::string &strFeatureName=string(""), const std::string &strQualifierName=string(""), const std::string &strQualifierValue=string(""), const TVecOfLines &vecOfOtherLines=TVecOfLines())
 Use this because the constructor is protected. More...
 
- Static Public Member Functions inherited from ILineError
static std::string ProblemStr (EProblem eProblem)
 

Protected Member Functions

 CLineErrorEx (EProblem eProblem, EDiagSev eSeverity, int code, int subcode, const std::string &strSeqId, unsigned int uLine, const std::string &strErrorMessage, const std::string &strFeatureName, const std::string &strQualifierName, const std::string &strQualifierValue, const TVecOfLines &m_vecOfOtherLine)
 protected instead of public. Please use the Create function instead. More...
 
 CLineErrorEx (const CLineErrorEx &rhs)
 protected instead of public. More...
 

Protected Attributes

EProblem m_eProblem
 
EDiagSev m_eSeverity
 
int m_Code
 
int m_Subcode
 
std::string m_strSeqId
 
unsigned int m_uLine
 
std::string m_strFeatureName
 
std::string m_strQualifierName
 
std::string m_strQualifierValue
 
std::string m_strErrorMessage
 
TVecOfLines m_vecOfOtherLines
 

Additional Inherited Members

- Public Types inherited from ILineError
enum  EProblem {
  eProblem_Unset = 1 , eProblem_UnrecognizedFeatureName , eProblem_UnrecognizedQualifierName , eProblem_NumericQualifierValueHasExtraTrailingCharacters ,
  eProblem_NumericQualifierValueIsNotANumber , eProblem_FeatureNameNotAllowed , eProblem_NoFeatureProvidedOnIntervals , eProblem_QualifierWithoutFeature ,
  eProblem_IncompleteFeature , eProblem_FeatureBadStartAndOrStop , eProblem_BadFeatureInterval , eProblem_QualifierBadValue ,
  eProblem_BadScoreValue , eProblem_MissingContext , eProblem_BadTrackLine , eProblem_InternalPartialsInFeatLocation ,
  eProblem_FeatMustBeInXrefdGene , eProblem_CreatedGeneFromMultipleFeats , eProblem_UnrecognizedSquareBracketCommand , eProblem_TooLong ,
  eProblem_UnexpectedNucResidues , eProblem_UnexpectedAminoAcids , eProblem_TooManyAmbiguousResidues , eProblem_InvalidResidue ,
  eProblem_ModifierFoundButNoneExpected , eProblem_ExtraModifierFound , eProblem_ExpectedModifierMissing , eProblem_Missing ,
  eProblem_NonPositiveLength , eProblem_ParsingModifiers , eProblem_ContradictoryModifiers , eProblem_InvalidLengthAutoCorrected ,
  eProblem_IgnoredResidue , eProblem_DiscouragedFeatureName , eProblem_DiscouragedQualifierName , eProblem_InvalidQualifier ,
  eProblem_InconsistentQualifiers , eProblem_DuplicateIDs , eProblem_BadInfoLine , eProblem_BadFormatLine ,
  eProblem_BadFilterLine , eProblem_ProgressInfo , eProblem_GeneralParsingError
}
 
typedef vector< unsigned intTVecOfLines
 

Detailed Description

Definition at line 486 of file line_error.hpp.

Constructor & Destructor Documentation

◆ ~CLineErrorEx()

virtual CLineErrorEx::~CLineErrorEx ( void  )
inlinevirtual

Definition at line 512 of file line_error.hpp.

◆ CLineErrorEx() [1/2]

CLineErrorEx::CLineErrorEx ( EProblem  eProblem,
EDiagSev  eSeverity,
int  code,
int  subcode,
const std::string strSeqId,
unsigned int  uLine,
const std::string strErrorMessage,
const std::string strFeatureName,
const std::string strQualifierName,
const std::string strQualifierValue,
const TVecOfLines m_vecOfOtherLine 
)
protected

protected instead of public. Please use the Create function instead.

Definition at line 141 of file line_error.cpp.

Referenced by Clone(), and Create().

◆ CLineErrorEx() [2/2]

CLineErrorEx::CLineErrorEx ( const CLineErrorEx rhs)
protected

protected instead of public.

Please use the Throw function to throw this exception and try to avoid using the copy constructor at all.

Definition at line 163 of file line_error.cpp.

Member Function Documentation

◆ AddOtherLine()

void CLineErrorEx::AddOtherLine ( unsigned int  uOtherLine)
inline

Definition at line 523 of file line_error.hpp.

References m_vecOfOtherLines.

◆ Clone()

ILineError * CLineErrorEx::Clone ( void  ) const
overridevirtual

Use this because copy ctor is protected.

Reimplemented from ILineError.

Definition at line 186 of file line_error.cpp.

References CLineErrorEx().

◆ Create()

CLineErrorEx * CLineErrorEx::Create ( EProblem  eProblem,
EDiagSev  eSeverity,
int  code,
int  subcode,
const std::string strSeqId,
unsigned int  uLine,
const std::string strErrorMessage = string(""),
const std::string strFeatureName = string(""),
const std::string strQualifierName = string(""),
const std::string strQualifierValue = string(""),
const TVecOfLines vecOfOtherLines = TVecOfLines() 
)
static

Use this because the constructor is protected.

Returns
Caller is responsible for the return value.

Definition at line 103 of file line_error.cpp.

References CLineErrorEx().

Referenced by CDefaultModErrorReporter::operator()(), CAlnErrorReporter::Report(), s_PostError(), sPostError(), sReportError(), sReportUnappliedStructuredComment(), and sReportUnusedMods().

◆ ErrorMessage()

const std::string& CLineErrorEx::ErrorMessage ( void  ) const
inlineoverridevirtual

Reimplemented from ILineError.

Definition at line 561 of file line_error.hpp.

References m_strErrorMessage.

Referenced by ProblemStr().

◆ FeatureName()

const std::string& CLineErrorEx::FeatureName ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 543 of file line_error.hpp.

References m_strFeatureName.

◆ GetCode()

virtual int CLineErrorEx::GetCode ( void  ) const
inlineoverridevirtual

Reimplemented from ILineError.

Definition at line 570 of file line_error.hpp.

References m_Code.

◆ GetSubCode()

virtual int CLineErrorEx::GetSubCode ( void  ) const
inlineoverridevirtual

Reimplemented from ILineError.

Definition at line 571 of file line_error.hpp.

References m_Subcode.

◆ Line()

unsigned int CLineErrorEx::Line ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 537 of file line_error.hpp.

References m_uLine.

◆ Message()

virtual string CLineErrorEx::Message ( void  ) const
inlineoverridevirtual

Reimplemented from ILineError.

Definition at line 563 of file line_error.hpp.

References m_strErrorMessage, and ILineError::Message().

◆ OtherLines()

const TVecOfLines& CLineErrorEx::OtherLines ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 540 of file line_error.hpp.

References m_vecOfOtherLines.

◆ PatchLineNumber()

void CLineErrorEx::PatchLineNumber ( unsigned int  uLine)
inline

Definition at line 518 of file line_error.hpp.

References m_uLine.

◆ Problem()

EProblem CLineErrorEx::Problem ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 528 of file line_error.hpp.

References m_eProblem.

Referenced by ProblemStr().

◆ ProblemStr()

virtual std::string CLineErrorEx::ProblemStr ( void  ) const
inlineoverridevirtual

◆ QualifierName()

const std::string& CLineErrorEx::QualifierName ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 546 of file line_error.hpp.

References m_strQualifierName.

◆ QualifierValue()

const std::string& CLineErrorEx::QualifierValue ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 549 of file line_error.hpp.

References m_strQualifierValue.

◆ SeqId()

const std::string& CLineErrorEx::SeqId ( void  ) const
inlineoverridevirtual

Implements ILineError.

Definition at line 534 of file line_error.hpp.

References m_strSeqId.

◆ Severity()

virtual EDiagSev CLineErrorEx::Severity ( void  ) const
inlineoverridevirtual

Reimplemented from ILineError.

Definition at line 531 of file line_error.hpp.

References m_eSeverity.

◆ Throw()

void CLineErrorEx::Throw ( void  ) const

copy constructor is protected so please use this function to throw the object.

Definition at line 134 of file line_error.cpp.

Member Data Documentation

◆ m_Code

int CLineErrorEx::m_Code
protected

Definition at line 577 of file line_error.hpp.

Referenced by GetCode().

◆ m_eProblem

EProblem CLineErrorEx::m_eProblem
protected

Definition at line 575 of file line_error.hpp.

Referenced by Problem(), and ProblemStr().

◆ m_eSeverity

EDiagSev CLineErrorEx::m_eSeverity
protected

Definition at line 576 of file line_error.hpp.

Referenced by Severity().

◆ m_strErrorMessage

std::string CLineErrorEx::m_strErrorMessage
protected

Definition at line 584 of file line_error.hpp.

Referenced by ErrorMessage(), and Message().

◆ m_strFeatureName

std::string CLineErrorEx::m_strFeatureName
protected

Definition at line 581 of file line_error.hpp.

Referenced by FeatureName().

◆ m_strQualifierName

std::string CLineErrorEx::m_strQualifierName
protected

Definition at line 582 of file line_error.hpp.

Referenced by QualifierName().

◆ m_strQualifierValue

std::string CLineErrorEx::m_strQualifierValue
protected

Definition at line 583 of file line_error.hpp.

Referenced by QualifierValue().

◆ m_strSeqId

std::string CLineErrorEx::m_strSeqId
protected

Definition at line 579 of file line_error.hpp.

Referenced by SeqId().

◆ m_Subcode

int CLineErrorEx::m_Subcode
protected

Definition at line 578 of file line_error.hpp.

Referenced by GetSubCode().

◆ m_uLine

unsigned int CLineErrorEx::m_uLine
protected

Definition at line 580 of file line_error.hpp.

Referenced by Line(), and PatchLineNumber().

◆ m_vecOfOtherLines

TVecOfLines CLineErrorEx::m_vecOfOtherLines
protected

Definition at line 585 of file line_error.hpp.

Referenced by AddOtherLine(), and OtherLines().


The documentation for this class was generated from the following files:
Modified on Wed May 22 11:35:09 2024 by modify_doxy.py rev. 669887