#include "error_logger.hpp"
(Private to src/objtools/readers/unit_test.)

Inheritance diagram for CErrorLogger:

Collaboration diagram for CErrorLogger:

Public Member Functions
	CErrorLogger (const string &filename)

	~CErrorLogger ()

bool	PutError (const ILineError &err)
	Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing. More...

	CErrorLogger (const string &filename)

	~CErrorLogger ()

bool	PutError (const ILineError &err)
	Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing. More...

	CErrorLogger (const string &filename)

	~CErrorLogger ()

bool	PutError (const ILineError &err)
	Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing. More...

Public Member Functions inherited from CMessageListenerBase
	CMessageListenerBase ()

	~CMessageListenerBase () override

size_t	Count () const override

size_t	LevelCount (EDiagSev eSev) override
	Returns the number of errors seen so far at the given severity. More...

void	ClearAll () override
	Clear all accumulated messages. More...

const ILineError &	GetError (size_t uPos) const override
	0-based error retrieval. More...

virtual void	Dump ()

virtual void	Dump (std::ostream &out)

virtual void	DumpAsXML (std::ostream &out)

void	PutProgress (const string &sMessage, const Uint8 iNumDone, const Uint8 iNumTotal) override
	This is used for processing progress messages. More...

virtual void	SetProgressOstream (CNcbiOstream *pProgressOstrm, ENcbiOwnership eNcbiOwnership=eNoOwnership)
	This sets the stream to which progress messages are written. More...

Public Member Functions inherited from ILineErrorListener
	~ILineErrorListener () override

bool	PutMessage (const IObjtoolsMessage &message) override

virtual const ILineError &	Get (size_t index) const

virtual void	Progress (const string &message, Uint8 current, Uint8 total)

virtual const ILineError &	GetMessage (size_t index) const

virtual void	Clear ()

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

Public Member Functions inherited from IObjtoolsListener
virtual	~IObjtoolsListener (void)=default

virtual bool	SevEnabled (EDiagSev severity) const

Protected Attributes
ofstream	mStream

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 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)

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 CMessageListenerBase
void	StoreError (const ILineError &err)

void	StoreMessage (const IObjtoolsMessage &message)

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

Detailed Description

Definition at line 41 of file error_logger.hpp.

Constructor & Destructor Documentation

◆ CErrorLogger() [1/3]

CErrorLogger::CErrorLogger ( const string & filename )

inline

Definition at line 46 of file error_logger.hpp.

References mStream.

◆ ~CErrorLogger() [1/3]

CErrorLogger::~CErrorLogger ( )

inline

Definition at line 51 of file error_logger.hpp.

References mStream.

◆ CErrorLogger() [2/3]

CErrorLogger::CErrorLogger ( const string & filename )

inline

Definition at line 60 of file unit_test_alnreader.cpp.

References mStream.

◆ ~CErrorLogger() [2/3]

CErrorLogger::~CErrorLogger ( )

inline

Definition at line 65 of file unit_test_alnreader.cpp.

References mStream.

◆ CErrorLogger() [3/3]

CErrorLogger::CErrorLogger ( const string & filename )

inline

Definition at line 46 of file error_logger.hpp.

References mStream.

◆ ~CErrorLogger() [3/3]

CErrorLogger::~CErrorLogger ( )

inline

Definition at line 51 of file error_logger.hpp.

References mStream.

Member Function Documentation

◆ PutError() [1/3]

bool CErrorLogger::PutError ( const ILineError & )

inlinevirtual

Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing.

Implements ILineErrorListener.

Definition at line 56 of file error_logger.hpp.

References CMessageListenerBase::Count(), eDiag_Fatal, ILineError::GetCode(), ILineError::GetSubCode(), i, ILineError::Line(), ILineError::Message(), mStream, NCBI_THROW2, ILineError::Severity(), ILineError::SeverityStr(), NStr::Split(), and CMessageListenerBase::StoreError().

◆ PutError() [2/3]

bool CErrorLogger::PutError ( const ILineError & )

inlinevirtual

Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing.

Implements ILineErrorListener.

Definition at line 70 of file unit_test_alnreader.cpp.

References CMessageListenerBase::Count(), eDiag_Fatal, ENUM_METHOD_NAME, eReader_Alignment, eReader_Mods, ILineError::GetCode(), ILineError::GetSubCode(), i, ILineError::Line(), ILineError::Message(), mStream, NCBI_THROW2, ILineError::QualifierName(), ILineError::QualifierValue(), ILineError::SeqId(), ILineError::Severity(), ILineError::SeverityStr(), NStr::Split(), and CMessageListenerBase::StoreError().

◆ PutError() [3/3]

bool CErrorLogger::PutError ( const ILineError & )

inlinevirtual

Store error in the container, and return true if error was stored fine, and return false if the caller should terminate all further processing.

Implements ILineErrorListener.

Definition at line 56 of file error_logger.hpp.

References CMessageListenerBase::Count(), ILineError::Line(), ILineError::Message(), mStream, ILineError::SeverityStr(), and CMessageListenerBase::StoreError().

Member Data Documentation

◆ mStream

ofstream CErrorLogger::mStream

protected

Definition at line 95 of file error_logger.hpp.

Referenced by CErrorLogger(), PutError(), and ~CErrorLogger().

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

src/objtools/readers/unit_test/error_logger.hpp
src/objtools/readers/unit_test/unit_test_alnreader.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CErrorLogger() [1/3]

◆ ~CErrorLogger() [1/3]

◆ CErrorLogger() [2/3]

◆ ~CErrorLogger() [2/3]

◆ CErrorLogger() [3/3]

◆ ~CErrorLogger() [3/3]

Member Function Documentation

◆ PutError() [1/3]

◆ PutError() [2/3]

◆ PutError() [3/3]

Member Data Documentation

◆ mStream