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

Search Toolkit Book for CObjtoolsListener

#include <objtools/logging/listener.hpp>

+ Inheritance diagram for CObjtoolsListener:
+ Collaboration diagram for CObjtoolsListener:

Classes

class  CConstIterator
 

Public Types

using TConstIterator = CConstIterator
 

Public Member Functions

 CObjtoolsListener ()=default
 
 CObjtoolsListener (const CObjtoolsListener &)=delete
 
CObjtoolsListeneroperator= (const CObjtoolsListener &)=delete
 
virtual ~CObjtoolsListener (void)
 
virtual bool PutMessage (const IObjtoolsMessage &message)
 
virtual void PutProgress (const string &message, const Uint8 iNumDone, const Uint8 iNumTotal)
 
virtual const IObjtoolsMessageGetMessage (size_t index) const
 
virtual size_t Count (void) const
 
virtual void ClearAll (void)
 
virtual size_t LevelCount (EDiagSev severity) const
 
virtual void Dump (CNcbiOstream &ostr) const
 
virtual void DumpAsXML (CNcbiOstream &ostr) const
 
virtual void SetProgressOstream (CNcbiOstream *pProgressOstream)
 
TConstIterator begin (void) const
 
TConstIterator end (void) const
 
- Public Member Functions inherited from IObjtoolsListener
virtual ~IObjtoolsListener (void)=default
 
virtual bool SevEnabled (EDiagSev severity) const
 

Protected Types

using TMessages = vector< unique_ptr< IObjtoolsMessage > >
 

Protected Attributes

TMessages m_Messages
 
CNcbiOstreamm_pProgressOstrm = nullptr
 

Private Types

using TBaseIterator = TMessages::const_iterator
 

Detailed Description

Definition at line 58 of file listener.hpp.

Member Typedef Documentation

◆ TBaseIterator

using CObjtoolsListener::TBaseIterator = TMessages::const_iterator
private

Definition at line 64 of file listener.hpp.

◆ TConstIterator

Definition at line 107 of file listener.hpp.

◆ TMessages

using CObjtoolsListener::TMessages = vector<unique_ptr<IObjtoolsMessage> >
protected

Definition at line 62 of file listener.hpp.

Constructor & Destructor Documentation

◆ CObjtoolsListener() [1/2]

CObjtoolsListener::CObjtoolsListener ( )
default

◆ CObjtoolsListener() [2/2]

CObjtoolsListener::CObjtoolsListener ( const CObjtoolsListener )
delete

◆ ~CObjtoolsListener()

CObjtoolsListener::~CObjtoolsListener ( void  )
virtualdefault

Member Function Documentation

◆ begin()

CObjtoolsListener::TConstIterator CObjtoolsListener::begin ( void  ) const

Definition at line 182 of file listener.cpp.

References m_Messages.

◆ ClearAll()

void CObjtoolsListener::ClearAll ( void  )
virtual

Definition at line 139 of file listener.cpp.

References m_Messages.

◆ Count()

size_t CObjtoolsListener::Count ( void  ) const
virtual

Definition at line 132 of file listener.cpp.

References m_Messages.

Referenced by CFlat2AsnApp::Run().

◆ Dump()

void CObjtoolsListener::Dump ( CNcbiOstream ostr) const
virtual

Reimplemented in CFlat2AsnListener.

Definition at line 155 of file listener.cpp.

References m_Messages.

Referenced by CFlat2AsnListener::Dump().

◆ DumpAsXML()

void CObjtoolsListener::DumpAsXML ( CNcbiOstream ostr) const
virtual

Definition at line 167 of file listener.cpp.

References m_Messages.

◆ end()

CObjtoolsListener::TConstIterator CObjtoolsListener::end ( void  ) const

Definition at line 188 of file listener.cpp.

References m_Messages.

◆ GetMessage()

const IObjtoolsMessage & CObjtoolsListener::GetMessage ( size_t  index) const
virtual

Definition at line 125 of file listener.cpp.

References m_Messages.

◆ LevelCount()

size_t CObjtoolsListener::LevelCount ( EDiagSev  severity) const
virtual

Reimplemented in CTeamCityMessageListener.

Definition at line 144 of file listener.cpp.

References m_Messages.

◆ operator=()

CObjtoolsListener& CObjtoolsListener::operator= ( const CObjtoolsListener )
delete

◆ PutMessage()

bool CObjtoolsListener::PutMessage ( const IObjtoolsMessage message)
virtual

◆ PutProgress()

void CObjtoolsListener::PutProgress ( const string message,
const Uint8  iNumDone,
const Uint8  iNumTotal 
)
virtual

Definition at line 61 of file listener.cpp.

References ITERATE, m_pProgressOstrm, NcbiEndl, and NStr::XmlEncode().

Referenced by CReaderListener::Progress().

◆ SetProgressOstream()

void CObjtoolsListener::SetProgressOstream ( CNcbiOstream pProgressOstream)
virtual

Definition at line 118 of file listener.cpp.

References m_pProgressOstrm.

Member Data Documentation

◆ m_Messages

TMessages CObjtoolsListener::m_Messages
protected

◆ m_pProgressOstrm

CNcbiOstream* CObjtoolsListener::m_pProgressOstrm = nullptr
protected

Definition at line 112 of file listener.hpp.

Referenced by PutProgress(), and SetProgressOstream().


The documentation for this class was generated from the following files:
Modified on Mon Jul 22 05:06:38 2024 by modify_doxy.py rev. 669887