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

Search Toolkit Book for CTestAction

+ Inheritance diagram for CTestAction:
+ Collaboration diagram for CTestAction:

Public Member Functions

 CTestAction (CBlastDbCheckLog &log, const string &nm, int flags)
 
virtual int DoTest (CSeqDB &db, TSeen &seen)=0
 
ostream & Log (CSeqDB &db, int lvl)
 
ostream & LogMore (int lvl)
 
string Name ()
 
bool TestOID (CSeqDB &db, TSeen &seen, int oid)
 
int LogLevel ()
 
- 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 Attributes

int m_Flags
 

Private Attributes

CBlastDbCheckLogm_Log
 
const string m_TestName
 

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

Detailed Description

Definition at line 294 of file blastdbcheck.cpp.

Constructor & Destructor Documentation

◆ CTestAction()

CTestAction::CTestAction ( CBlastDbCheckLog log,
const string nm,
int  flags 
)
inline

Definition at line 296 of file blastdbcheck.cpp.

Member Function Documentation

◆ DoTest()

virtual int CTestAction::DoTest ( CSeqDB db,
TSeen seen 
)
pure virtual

◆ Log()

ostream& CTestAction::Log ( CSeqDB db,
int  lvl 
)
inline

◆ LogLevel()

int CTestAction::LogLevel ( )
inline

Definition at line 321 of file blastdbcheck.cpp.

References CBlastDbCheckLog::GetLevel(), and m_Log.

◆ LogMore()

ostream& CTestAction::LogMore ( int  lvl)
inline

Definition at line 309 of file blastdbcheck.cpp.

References CBlastDbCheckLog::Log(), and m_Log.

◆ Name()

string CTestAction::Name ( )
inline

Definition at line 314 of file blastdbcheck.cpp.

References m_TestName.

◆ TestOID()

bool CTestAction::TestOID ( CSeqDB db,
TSeen seen,
int  oid 
)

Member Data Documentation

◆ m_Flags

int CTestAction::m_Flags
protected

Definition at line 331 of file blastdbcheck.cpp.

Referenced by CMetaDataTest::DoTest(), and TestOID().

◆ m_Log

CBlastDbCheckLog& CTestAction::m_Log
private

Definition at line 327 of file blastdbcheck.cpp.

Referenced by CAliasTest::Log(), Log(), LogLevel(), and LogMore().

◆ m_TestName

const string CTestAction::m_TestName
private

Definition at line 328 of file blastdbcheck.cpp.

Referenced by CAliasTest::Log(), Log(), and Name().


The documentation for this class was generated from the following file:
Modified on Sat Dec 02 09:22:03 2023 by modify_doxy.py rev. 669887