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

Search Toolkit Book for CMessageListenerWithLog

#include <objtools/readers/message_listener.hpp>

+ Inheritance diagram for CMessageListenerWithLog:
+ Collaboration diagram for CMessageListenerWithLog:

Public Member Functions

 CMessageListenerWithLog (const CDiagCompileInfo &info)
 
 ~CMessageListenerWithLog () override
 
bool PutError (const ILineError &err) override
 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 ILineErrorGetError (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 ILineErrorGet (size_t index) const
 
virtual void Progress (const string &message, Uint8 current, Uint8 total)
 
virtual const ILineErrorGetMessage (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...
 
CObjectoperator= (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
 

Private Attributes

const CDiagCompileInfo m_Info
 

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< Uint8TCounter
 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 314 of file message_listener.hpp.

Constructor & Destructor Documentation

◆ CMessageListenerWithLog()

CMessageListenerWithLog::CMessageListenerWithLog ( const CDiagCompileInfo info)
inline

Definition at line 317 of file message_listener.hpp.

◆ ~CMessageListenerWithLog()

CMessageListenerWithLog::~CMessageListenerWithLog ( )
inlineoverride

Definition at line 319 of file message_listener.hpp.

Member Function Documentation

◆ PutError()

bool CMessageListenerWithLog::PutError ( const ILineError )
inlineoverridevirtual

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 321 of file message_listener.hpp.

References eDPF_IsMessage, eDPF_Log, CNcbiDiag::GetRef(), m_Info, ILineError::Message(), ILineError::Severity(), and CMessageListenerBase::StoreError().

Member Data Documentation

◆ m_Info

const CDiagCompileInfo CMessageListenerWithLog::m_Info
private

Definition at line 331 of file message_listener.hpp.

Referenced by PutError().


The documentation for this class was generated from the following file:
Modified on Mon Jun 17 05:04:30 2024 by modify_doxy.py rev. 669887