Search Toolkit Book for CDiscrepancySet

#include <misc/discrepancy/discrepancy.hpp>

Inheritance diagram for CDiscrepancySet:

Collaboration diagram for CDiscrepancySet:

Public Types
enum	EOutput { eOutput_Summary = 1 << 0 , eOutput_Fatal = 1 << 1 , eOutput_Ext = 1 << 2 , eOutput_Files = 1 << 3 }

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

Public Member Functions
virtual	~CDiscrepancySet ()

virtual CRef< CDiscrepancyProduct >	RunTests (const TTestNamesSet &testnames, const CSerialObject &object, const string &filename)=0

virtual CRef< CDiscrepancyProduct >	GetProduct ()=0

virtual unsigned	Summarize ()=0

virtual map< string, size_t >	Autofix ()=0

virtual void	ParseStream (CObjectIStream &stream, const string &fname, bool skip, const string &default_header=kEmptyStr)=0

virtual void	AddTest (eTestNames name)=0

virtual void	AddTest (string_view name)=0

virtual void	ParseStrings (const string &fname)=0

virtual void	Push (const CSerialObject &root, const string &fname=kEmptyStr)=0

virtual void	Parse ()=0

virtual TDiscrepancyCaseMap	GetTests () const =0

virtual void	Autofix (TReportObjectList &tofix, map< string, size_t > &rep, const string &default_header=kEmptyStr)=0

void	SetUserData (void *p)

void *	GetUserData () const

const string &	GetLineage () const

void	SetLineage (const string &s)

virtual void	SetSuspectRules (const string &name, bool read=true)=0

virtual const CSerialObject *	FindObject (CReportObj &obj, bool alt=false)=0

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

Static Public Member Functions
static void	SetGui (bool b)

static bool	IsGui ()

static CRef< CDiscrepancySet >	New (objects::CScope &scope)

static string	Format (const string &str, unsigned int count)

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)

Protected Member Functions
	CDiscrepancySet ()

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

Protected Attributes
string	m_Lineage

void *	m_UserData = nullptr

Static Protected Attributes
static std::atomic< bool >	m_Gui = false

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

Detailed Description

Definition at line 182 of file discrepancy.hpp.

Member Enumeration Documentation

◆ EOutput

enum CDiscrepancySet::EOutput

Enumerator
eOutput_Summary
eOutput_Fatal
eOutput_Ext
eOutput_Files

Definition at line 217 of file discrepancy.hpp.

Constructor & Destructor Documentation

◆ CDiscrepancySet()

CDiscrepancySet::CDiscrepancySet ( )

inlineprotected

Definition at line 185 of file discrepancy.hpp.

◆ ~CDiscrepancySet()

virtual CDiscrepancySet::~CDiscrepancySet ( )

inlinevirtual

Definition at line 187 of file discrepancy.hpp.

Member Function Documentation

◆ AddTest() [1/2]

virtual void CDiscrepancySet::AddTest ( eTestNames name )

pure virtual

Implemented in CDiscrepancyContext.

◆ AddTest() [2/2]

virtual void CDiscrepancySet::AddTest ( string_view name )

pure virtual

Implemented in CDiscrepancyContext.

◆ Autofix() [1/2]

virtual map<string, size_t> CDiscrepancySet::Autofix ( )

pure virtual

Implemented in CDiscrepancyContext.

◆ Autofix() [2/2]

virtual void CDiscrepancySet::Autofix	(	TReportObjectList &	tofix,
		map< string, size_t > &	rep,
		const string &	default_header = `kEmptyStr`
	)

pure virtual

Implemented in CDiscrepancyContext.

References test_name.

◆ FindObject()

virtual const CSerialObject* CDiscrepancySet::FindObject	(	CReportObj &	obj,
		bool	alt = `false`
	)

pure virtual

Implemented in CDiscrepancyContext.

◆ Format()

string CDiscrepancySet::Format	(	const string &	str,
		unsigned int	count
	)

static

Definition at line 497 of file discrepancy_core.cpp.

References count, NStr::Find(), NStr::Int8ToString(), n, NPOS, NStr::ReplaceInPlace(), str(), and NStr::TruncateSpacesInPlace().

Referenced by BOOST_AUTO_TEST_CASE(), and CDiscrepancyPanel::OnAutofix().

◆ GetLineage()

const string& CDiscrepancySet::GetLineage ( ) const

inline

Definition at line 230 of file discrepancy.hpp.

References m_Lineage.

Referenced by CDiscrepancyContext::HasLineage(), and CDiscrepancyContext::IsEukaryotic().

◆ GetProduct()

virtual CRef<CDiscrepancyProduct> CDiscrepancySet::GetProduct ( )

pure virtual

Implemented in CDiscrepancyContext.

◆ GetTests()

virtual TDiscrepancyCaseMap CDiscrepancySet::GetTests ( ) const

pure virtual

Implemented in CDiscrepancyContext.

◆ GetUserData()

void* CDiscrepancySet::GetUserData ( ) const

inline

Definition at line 225 of file discrepancy.hpp.

References m_UserData.

◆ IsGui()

static bool CDiscrepancySet::IsGui ( )

inlinestatic

Definition at line 228 of file discrepancy.hpp.

References m_Gui.

Referenced by CDiscrepancyVisitorImpl< _Name >::Summarize().

◆ New()

CRef< CDiscrepancySet > CDiscrepancySet::New ( objects::CScope & scope )

static

Definition at line 494 of file discrepancy_core.cpp.

Referenced by CDiscrepancyPanel::RunTests(), CDiscRepApp::x_ProcessAll(), and CDiscRepApp::x_ProcessOne().

◆ Parse()

virtual void CDiscrepancySet::Parse ( )

pure virtual

Implemented in CDiscrepancyContext.

◆ ParseStream()

virtual void CDiscrepancySet::ParseStream	(	CObjectIStream &	stream,
		const string &	fname,
		bool	skip,
		const string &	default_header = `kEmptyStr`
	)

pure virtual

Implemented in CDiscrepancyContext.

◆ ParseStrings()

virtual void CDiscrepancySet::ParseStrings ( const string & fname )

pure virtual

Implemented in CDiscrepancyContext.

◆ Push()

virtual void CDiscrepancySet::Push	(	const CSerialObject &	root,
		const string &	fname = `kEmptyStr`
	)

pure virtual

Implemented in CDiscrepancyContext.

◆ RunTests()

virtual CRef<CDiscrepancyProduct> CDiscrepancySet::RunTests	(	const TTestNamesSet &	testnames,
		const CSerialObject &	object,
		const string &	filename
	)

pure virtual

Implemented in CDiscrepancyContext.

◆ SetGui()

static void CDiscrepancySet::SetGui ( bool b )

inlinestatic

Definition at line 227 of file discrepancy.hpp.

References b, and m_Gui.

◆ SetLineage()

void CDiscrepancySet::SetLineage ( const string & s )

inline

Definition at line 231 of file discrepancy.hpp.

References m_Lineage.

◆ SetSuspectRules()

virtual void CDiscrepancySet::SetSuspectRules	(	const string &	name,
		bool	read = `true`
	)

pure virtual

Implemented in CDiscrepancyContext.

◆ SetUserData()

void CDiscrepancySet::SetUserData ( void * p )

inline

Definition at line 224 of file discrepancy.hpp.

References m_UserData.

◆ Summarize()

virtual unsigned CDiscrepancySet::Summarize ( )

pure virtual

Implemented in CDiscrepancyContext.

Member Data Documentation

◆ m_Gui

std::atomic< bool > CDiscrepancySet::m_Gui = false

staticprotected

Definition at line 244 of file discrepancy.hpp.

Referenced by IsGui(), and SetGui().

◆ m_Lineage

string CDiscrepancySet::m_Lineage

protected

Definition at line 242 of file discrepancy.hpp.

Referenced by GetLineage(), and SetLineage().

◆ m_UserData

void* CDiscrepancySet::m_UserData = nullptr

protected

Definition at line 245 of file discrepancy.hpp.

Referenced by GetUserData(), and SetUserData().

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

include/misc/discrepancy/discrepancy.hpp
src/misc/discrepancy/discrepancy_core.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EOutput

Constructor & Destructor Documentation

◆ CDiscrepancySet()

◆ ~CDiscrepancySet()

Member Function Documentation

◆ AddTest() [1/2]

◆ AddTest() [2/2]

◆ Autofix() [1/2]

◆ Autofix() [2/2]

◆ FindObject()

◆ Format()

◆ GetLineage()

◆ GetProduct()

◆ GetTests()

◆ GetUserData()

◆ IsGui()

◆ New()

◆ Parse()

◆ ParseStream()

◆ ParseStrings()

◆ Push()

◆ RunTests()

◆ SetGui()

◆ SetLineage()

◆ SetSuspectRules()

◆ SetUserData()

◆ Summarize()

Member Data Documentation

◆ m_Gui

◆ m_Lineage

◆ m_UserData