NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
CDMSearchProgress Class Reference

Search Toolkit Book for CDMSearchProgress

CDMSearchProgress CDMSearchProgress represents the specialized progress report that may contain intermediate data mining results. More...

#include <gui/core/dm_search_tool.hpp>

+ Inheritance diagram for CDMSearchProgress:
+ Collaboration diagram for CDMSearchProgress:

Public Member Functions

 CDMSearchProgress (const string &msg, CDMSearchResult *result)
 
- Public Member Functions inherited from CAppJobProgress
 CAppJobProgress ()
 CAppJobProgress. More...
 
 CAppJobProgress (float done, const string &text)
 
 CAppJobProgress (const CAppJobProgress &progress)
 
CAppJobProgressoperator= (const CAppJobProgress &progress)
 
void SetNormDone (float done)
 
void SetText (const string &text)
 
virtual float GetNormDone () const override
 return a number indicating the progress(0.0 - just started, 1.0 - done) More...
 
virtual string GetText () const override
 returns a text string describing current state More...
 
- 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
 
- Public Member Functions inherited from IAppJobProgress
virtual ~IAppJobProgress ()
 

Public Attributes

CRef< CDMSearchResultm_Result
 

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...
 
- Protected Attributes inherited from CAppJobProgress
float m_Done
 
string m_Text
 
CGuiRWLock m_Lock
 MT sync.lock. More...
 

Detailed Description

CDMSearchProgress CDMSearchProgress represents the specialized progress report that may contain intermediate data mining results.

Every CDMSearchProgress assumes ownership of the results, the search job must create a separate copy of its results in order to supply it with the Progress notification.

Definition at line 192 of file dm_search_tool.hpp.

Constructor & Destructor Documentation

◆ CDMSearchProgress()

CDMSearchProgress::CDMSearchProgress ( const string msg,
CDMSearchResult result 
)
inline

Definition at line 195 of file dm_search_tool.hpp.

Member Data Documentation

◆ m_Result

CRef<CDMSearchResult> CDMSearchProgress::m_Result

Definition at line 200 of file dm_search_tool.hpp.

Referenced by CSearchToolBase::OnProgress().


The documentation for this class was generated from the following file:
Modified on Tue Feb 27 05:56:10 2024 by modify_doxy.py rev. 669887