NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CReportItem Class Referenceabstract

Search Toolkit Book for CReportItem

#include <misc/discrepancy/discrepancy.hpp>

+ Inheritance diagram for CReportItem:
+ Collaboration diagram for CReportItem:

Public Types

enum  ESeverity { eSeverity_info = 0 , eSeverity_warning = 1 , eSeverity_error = 2 }
 
- 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...
 

Public Member Functions

virtual ~CReportItem ()
 
virtual string_view GetTitle () const =0
 
virtual string GetStr () const =0
 
virtual string GetMsg () const =0
 
virtual string GetXml () const =0
 
virtual string GetUnit () const =0
 
virtual size_t GetCount () const =0
 
virtual TReportObjectList GetDetails () const =0
 
virtual vector< CRef< CReportItem > > GetSubitems () const =0
 
virtual bool CanAutofix () const =0
 
virtual ESeverity GetSeverity () const =0
 
virtual bool IsFatal () const =0
 
virtual bool IsInfo () const =0
 
virtual bool IsExtended () const =0
 
virtual bool IsSummary () const =0
 
virtual bool IsReal () const =0
 
- 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
 

Static Public Member Functions

static CRef< CReportItemCreateReportItem (const string &test, const CReportObj &obj, const string &msg, bool autofix=false)
 
- 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)
 

Additional Inherited Members

- 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 CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 118 of file discrepancy.hpp.

Member Enumeration Documentation

◆ ESeverity

Enumerator
eSeverity_info 
eSeverity_warning 
eSeverity_error 

Definition at line 121 of file discrepancy.hpp.

Constructor & Destructor Documentation

◆ ~CReportItem()

virtual CReportItem::~CReportItem ( )
inlinevirtual

Definition at line 126 of file discrepancy.hpp.

Member Function Documentation

◆ CanAutofix()

virtual bool CReportItem::CanAutofix ( ) const
pure virtual

◆ CreateReportItem()

CRef< CReportItem > CReportItem::CreateReportItem ( const string test,
const CReportObj obj,
const string msg,
bool  autofix = false 
)
static

◆ GetCount()

virtual size_t CReportItem::GetCount ( ) const
pure virtual

Implemented in CDiscrepancyItem.

◆ GetDetails()

virtual TReportObjectList CReportItem::GetDetails ( ) const
pure virtual

◆ GetMsg()

virtual string CReportItem::GetMsg ( ) const
pure virtual

◆ GetSeverity()

virtual ESeverity CReportItem::GetSeverity ( ) const
pure virtual

Implemented in CDiscrepancyItem.

Referenced by CReportNode::Export().

◆ GetStr()

virtual string CReportItem::GetStr ( ) const
pure virtual

Implemented in CDiscrepancyItem.

Referenced by CDiscRepItem::GetStr().

◆ GetSubitems()

virtual vector<CRef<CReportItem> > CReportItem::GetSubitems ( ) const
pure virtual

◆ GetTitle()

virtual string_view CReportItem::GetTitle ( ) const
pure virtual

◆ GetUnit()

virtual string CReportItem::GetUnit ( ) const
pure virtual

Implemented in CDiscrepancyItem.

Referenced by CReportNode::Export().

◆ GetXml()

virtual string CReportItem::GetXml ( ) const
pure virtual

Implemented in CDiscrepancyItem.

◆ IsExtended()

virtual bool CReportItem::IsExtended ( ) const
pure virtual

Implemented in CDiscrepancyItem.

◆ IsFatal()

virtual bool CReportItem::IsFatal ( ) const
pure virtual

◆ IsInfo()

virtual bool CReportItem::IsInfo ( ) const
pure virtual

Implemented in CDiscrepancyItem.

◆ IsReal()

virtual bool CReportItem::IsReal ( ) const
pure virtual

Implemented in CDiscrepancyItem.

Referenced by CDiscRepItem::IsReal().

◆ IsSummary()

virtual bool CReportItem::IsSummary ( ) const
pure virtual

Implemented in CDiscrepancyItem.


The documentation for this class was generated from the following files:
Modified on Sun Jun 16 04:29:32 2024 by modify_doxy.py rev. 669887