NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CDiscrepancyCore Class Referenceabstract

Search Toolkit Book for CDiscrepancyCore

#include "discrepancy_core.hpp"
(Private to src/misc/discrepancy.)

+ Inheritance diagram for CDiscrepancyCore:
+ Collaboration diagram for CDiscrepancyCore:

Public Member Functions

 CDiscrepancyCore (const CDiscrepancyCaseProps *props)
 
eTestNames GetName () const override
 
string_view GetSName () const override
 
string_view GetDescription () const override
 
eTestTypes GetType () const override
 
virtual void Summarize ()=0
 
bool Empty () const
 
const TReportItemListGetReport () const override
 
TReportObjectList GetObjects () const override
 
virtual CRef< CAutofixReportAutofix (CDiscrepancyObject *obj, CDiscrepancyContext &context) const =0
 
void Call (CDiscrepancyContext &context)
 
virtual void Visit (CDiscrepancyContext &context)=0
 
void Merge (CDiscrepancyCore &other)
 
- Public Member Functions inherited from CDiscrepancyCase
virtual ~CDiscrepancyCase ()
 
- 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
 

Protected Member Functions

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

Protected Attributes

CReportNode m_Objs
 
TReportItemList m_ReportItems
 
const CDiscrepancyCasePropsm_props
 

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

Detailed Description

Definition at line 204 of file discrepancy_core.hpp.

Constructor & Destructor Documentation

◆ CDiscrepancyCore()

CDiscrepancyCore::CDiscrepancyCore ( const CDiscrepancyCaseProps props)
inline

Definition at line 207 of file discrepancy_core.hpp.

Referenced by BOOST_AUTO_TEST_CASE().

Member Function Documentation

◆ Autofix()

virtual CRef<CAutofixReport> CDiscrepancyCore::Autofix ( CDiscrepancyObject obj,
CDiscrepancyContext context 
) const
pure virtual

◆ Call()

void CDiscrepancyCore::Call ( CDiscrepancyContext context)

Definition at line 480 of file discrepancy_core.cpp.

References m_Objs, Visit(), and CException::what().

◆ Empty()

bool CDiscrepancyCore::Empty ( void  ) const
inline

Definition at line 214 of file discrepancy_core.hpp.

References CReportNode::empty(), and m_Objs.

◆ GetDescription()

string_view CDiscrepancyCore::GetDescription ( void  ) const
inlineoverridevirtual

Implements CDiscrepancyCase.

Definition at line 210 of file discrepancy_core.hpp.

References CDiscrepancyCaseProps::Descr, and m_props.

◆ GetName()

eTestNames CDiscrepancyCore::GetName ( void  ) const
inlineoverridevirtual

Implements CDiscrepancyCase.

Definition at line 208 of file discrepancy_core.hpp.

References m_props, and CDiscrepancyCaseProps::Name.

◆ GetObjects()

TReportObjectList CDiscrepancyCore::GetObjects ( void  ) const
overridevirtual

Implements CDiscrepancyCase.

Definition at line 401 of file discrepancy_core.cpp.

References CReportNode::Add(), and GetReport().

◆ GetReport()

const TReportItemList& CDiscrepancyCore::GetReport ( void  ) const
inlineoverridevirtual

Implements CDiscrepancyCase.

Definition at line 215 of file discrepancy_core.hpp.

References m_ReportItems.

Referenced by GetObjects().

◆ GetSName()

string_view CDiscrepancyCore::GetSName ( ) const
inlineoverridevirtual

Implements CDiscrepancyCase.

Definition at line 209 of file discrepancy_core.hpp.

References m_props, and CDiscrepancyCaseProps::sName.

◆ GetType()

eTestTypes CDiscrepancyCore::GetType ( void  ) const
inlineoverridevirtual

Implements CDiscrepancyCase.

Definition at line 211 of file discrepancy_core.hpp.

References m_props, and CDiscrepancyCaseProps::Type.

◆ Merge()

void CDiscrepancyCore::Merge ( CDiscrepancyCore other)

Definition at line 622 of file discrepancy_core.cpp.

References _ASSERT, m_Objs, m_ReportItems, and CReportNode::Merge().

◆ Summarize()

virtual void CDiscrepancyCore::Summarize ( )
pure virtual

Implemented in CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, CDiscrepancyVisitorImpl< _Name >, and CDiscrepancyVisitorImpl< _Name >.

Referenced by BOOST_AUTO_TEST_CASE().

◆ Visit()

virtual void CDiscrepancyCore::Visit ( CDiscrepancyContext context)
pure virtual

Implemented in CDiscrepancyVisitorImpl< _Name >.

Referenced by BOOST_AUTO_TEST_CASE(), and Call().

◆ xSummarize()

void CDiscrepancyCore::xSummarize ( )
protected

Member Data Documentation

◆ m_Objs

CReportNode CDiscrepancyCore::m_Objs
protected

Definition at line 223 of file discrepancy_core.hpp.

Referenced by Call(), Empty(), Merge(), and xSummarize().

◆ m_props

const CDiscrepancyCaseProps* CDiscrepancyCore::m_props
protected

Definition at line 226 of file discrepancy_core.hpp.

Referenced by GetDescription(), GetName(), GetSName(), and GetType().

◆ m_ReportItems

TReportItemList CDiscrepancyCore::m_ReportItems
protected

Definition at line 224 of file discrepancy_core.hpp.

Referenced by GetReport(), Merge(), and xSummarize().


The documentation for this class was generated from the following files:
Modified on Wed Feb 21 09:58:09 2024 by modify_doxy.py rev. 669887