#include <objects/valerr/ValidError.hpp>

Inheritance diagram for CValidError:

Collaboration diagram for CValidError:

Public Member Functions
	CValidError (const CSerialObject *obj=nullptr)

virtual	~CValidError ()

void	AddValidErrItem (EDiagSev sev, unsigned int ec, const string &msg, const string &desc, const CSerialObject &obj, const string &acc, const int ver, const string &location=kEmptyStr, const int seq_offset=0) final

void	AddValidErrItem (EDiagSev sev, unsigned int ec, const string &msg, const string &desc, const string &acc, const int ver, const string &location=kEmptyStr, const int seq_offset=0) final

void	AddValidErrItem (EDiagSev sev, unsigned int ec, const string &msg, const string &desc, const CSeqdesc &seqdesc, const CSeq_entry &ctx, const string &acc, const int ver, const int seq_offset=0) final

void	AddValidErrItem (EDiagSev sev, unsigned int ec, const string &msg) final

void	AddValidErrItem (CRef< CValidErrItem > item) final

SIZE_TYPE	TotalSize () const

SIZE_TYPE	Size (EDiagSev sev) const

SIZE_TYPE	InfoSize () const

SIZE_TYPE	WarningSize () const

SIZE_TYPE	ErrorSize () const

SIZE_TYPE	CriticalSize () const

SIZE_TYPE	FatalSize () const

const CSerialObject *	GetValidated () const

void	SuppressError (unsigned int ec)

bool	ShouldSuppress (unsigned int ec)

void	ClearSuppressions ()

bool	IsCatastrophic () const

Public Member Functions inherited from CValidError_Base
	CValidError_Base (void)

virtual	~CValidError_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetErrs (void) const
	Check if a value has been assigned to Errs data member. More...

bool	CanGetErrs (void) const
	Check if it is safe to call GetErrs method. More...

void	ResetErrs (void)
	Reset Errs data member. More...

const TErrs &	GetErrs (void) const
	Get the Errs member data. More...

TErrs &	SetErrs (void)
	Assign a value to Errs data member. More...

virtual void	Reset (void)
	Reset the whole object. More...

Public Member Functions inherited from CSerialObject
	CSerialObject (void)

virtual	~CSerialObject (void)

virtual const CTypeInfo *	GetThisTypeInfo (void) const =0

virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...

virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

void	ThrowUnassigned (TMemberIndex index) const

void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const

bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...

const string &	GetNamespaceName (void) const
	Get namespace name. More...

bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...

const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...

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

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 IValidError
virtual	~IValidError ()=default

Protected Types
typedef map< EDiagSev, SIZE_TYPE >	TSevStats

typedef CConstRef< CSerialObject >	TValidated

typedef CConstRef< CSeq_entry >	TContext

Protected Attributes
TSevStats	m_Stats

TValidated	m_Validated

vector< unsigned int >	m_SuppressionList

Private Types
typedef CValidError_Base	Tparent

Private Member Functions
	CValidError (const CValidError &)=delete

CValidError &	operator= (const CValidError &)=delete

Friends
class	CValidError_CI

Additional Inherited Members
Public Types inherited from CValidError_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_errs }

typedef CValidErrItem	C_E

typedef vector< CRef< CValidErrItem > >	TErrs

typedef Tparent::CMemberIndex< E_memberIndex, 2 >	TmemberIndex

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

Static Public Member Functions inherited from CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)

static void	SetVerifyDataGlobal (ESerialVerifyData verify)

static string	UnassignedString (void)

static CStringUTF8	UnassignedStringUTF8 (void)

static char	UnassignedByte (void)

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 CSerialObject
static const char *	ms_UnassignedStr = "<unassigned>"

static const char	ms_UnassignedByte = char(0xcd)

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 102 of file ValidError.hpp.

Member Typedef Documentation

◆ TContext

typedef CConstRef<CSeq_entry> CValidError::TContext

protected

Definition at line 179 of file ValidError.hpp.

◆ Tparent

typedef CValidError_Base CValidError::Tparent

private

Definition at line 106 of file ValidError.hpp.

◆ TSevStats

typedef map<EDiagSev, SIZE_TYPE> CValidError::TSevStats

protected

Definition at line 177 of file ValidError.hpp.

◆ TValidated

typedef CConstRef<CSerialObject> CValidError::TValidated

protected

Definition at line 178 of file ValidError.hpp.

Constructor & Destructor Documentation

◆ CValidError() [1/2]

CValidError::CValidError ( const CSerialObject * obj = nullptr )

Definition at line 53 of file ValidError.cpp.

◆ ~CValidError()

CValidError::~CValidError ( )

virtual

Definition at line 182 of file ValidError.cpp.

◆ CValidError() [2/2]

CValidError::CValidError ( const CValidError & )

privatedelete

Member Function Documentation

◆ AddValidErrItem() [1/5]

void CValidError::AddValidErrItem ( CRef< CValidErrItem > item )

finalvirtual

Implements IValidError.

Definition at line 139 of file ValidError.cpp.

References CValidErrItem::ConvertErrCode(), CValidErrItem::ConvertErrGroup(), eDiag_Info, m_Stats, CValidError_Base::SetErrs(), and ShouldSuppress().

◆ AddValidErrItem() [2/5]

void CValidError::AddValidErrItem	(	EDiagSev	sev,
		unsigned int	ec,
		const string &	msg
	)

finalvirtual

Implements IValidError.

Definition at line 122 of file ValidError.cpp.

References CValidErrItem::ConvertErrCode(), CValidErrItem::ConvertErrGroup(), m_Stats, msg(), CValidError_Base::SetErrs(), and ShouldSuppress().

◆ AddValidErrItem() [3/5]

void CValidError::AddValidErrItem	(	EDiagSev	sev,
		unsigned int	ec,
		const string &	msg,
		const string &	desc,
		const CSeqdesc &	seqdesc,
		const CSeq_entry &	ctx,
		const string &	acc,
		const int	ver,
		const int	seq_offset = `0`
	)

finalvirtual

Implements IValidError.

Definition at line 102 of file ValidError.cpp.

References ctx, m_Stats, msg(), CValidError_Base::SetErrs(), and ShouldSuppress().

◆ AddValidErrItem() [4/5]

void CValidError::AddValidErrItem	(	EDiagSev	sev,
		unsigned int	ec,
		const string &	msg,
		const string &	desc,
		const CSerialObject &	obj,
		const string &	acc,
		const int	ver,
		const string &	location = `kEmptyStr`,
		const int	seq_offset = `0`
	)

finalvirtual

Implements IValidError.

Definition at line 58 of file ValidError.cpp.

References NStr::IsBlank(), location, m_Stats, msg(), CValidError_Base::SetErrs(), and ShouldSuppress().

◆ AddValidErrItem() [5/5]

void CValidError::AddValidErrItem	(	EDiagSev	sev,
		unsigned int	ec,
		const string &	msg,
		const string &	desc,
		const string &	acc,
		const int	ver,
		const string &	location = `kEmptyStr`,
		const int	seq_offset = `0`
	)