NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
CSeqDBDemo_Thread Class Reference

Search Toolkit Book for CSeqDBDemo_Thread

+ Inheritance diagram for CSeqDBDemo_Thread:
+ Collaboration diagram for CSeqDBDemo_Thread:

Public Member Functions

 CSeqDBDemo_Thread (int index, int at_a_time, int max_length)
 
virtual void * Main (void)
 Derived (user-created) class must provide a real thread function. More...
 
virtual void OnExit (void)
 Override this to execute finalization code. More...
 
const int GetIndex (void) const
 
bool IsRunning (void) const
 
- Public Member Functions inherited from CThread
 CThread (void)
 Constructor. More...
 
bool Run (TRunMode flags=fRunDefault)
 Run the thread. More...
 
void Detach (void)
 Inform the thread that user does not need to wait for its termination. More...
 
void Join (void **exit_data=0)
 Wait for the thread termination. More...
 
bool Discard (void)
 If the thread has not been Run() yet, then schedule the thread object for destruction, and return TRUE. More...
 
bool IsTerminated (void) const
 Check if the thread has been terminated. 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
 

Static Public Member Functions

static void Init (CSeqDB &db, bool oid_shuffle, bool use_ambigs)
 
- Static Public Member Functions inherited from CThread
static void Exit (void *exit_data)
 Cancel current thread. More...
 
static TID GetSelf (void)
 
static bool IsMain (void)
 
static CThreadGetCurrentThread (void)
 Get current CThread object (or NULL, if main thread) More...
 
static void GetSystemID (TThreadSystemID *id)
 Get system ID of the current thread - for internal use only. More...
 
static unsigned int GetThreadsCount ()
 Get total amount of threads This amount does not contain main thread. More...
 
static void SetCurrentThreadName (const CTempString &)
 Set name for the current thread. More...
 
static void InitializeMainThreadId (void)
 Initialize main thread's TID. More...
 
static bool IsAppExiting (void)
 Check if the application is exiting (entered the destructor). More...
 
static void SetWaitForAllThreadsTimeout (const CTimeout &timeout)
 Set timeout for stopping all threads on application exit. 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)
 

Private Member Functions

long x_UseOID (int letter, int oid)
 Use this OID as part of the set. More...
 

Private Attributes

const int m_Index
 
const int m_AtATime
 
const int m_MaxLength
 
bool m_Running
 
char * m_Temp
 

Static Private Attributes

static CSeqDBsm_sp = NULL
 
static bool sm_is_protein = false
 
static bool sm_oid_shuffle = false
 
static bool sm_use_ambigs = false
 
static int sm_oid_state = 0
 

Additional Inherited Members

- Public Types inherited from CThread
enum  ERunMode {
  fRunDefault = 0x00 , fRunDetached = 0x01 , fRunBound = 0x10 , fRunUnbound = 0x20 ,
  fRunNice = 0x40 , fRunAllowST = 0x100 , fRunCloneRequestContext = 0x200
}
 Which mode should the thread run in. More...
 
typedef int TRunMode
 Bitwise OR'd flags for thread creation passed to Run(). More...
 
typedef unsigned int TID
 Get ID of current thread. More...
 
- 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 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 CThread
virtual ~CThread (void)
 To be called only internally! NOTE: destructor of the derived (user-provided) class should be declared "protected", too! More...
 
TThreadHandle GetThreadHandle ()
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 281 of file seqdb_demo.cpp.

Constructor & Destructor Documentation

◆ CSeqDBDemo_Thread()

CSeqDBDemo_Thread::CSeqDBDemo_Thread ( int  index,
int  at_a_time,
int  max_length 
)

Definition at line 412 of file seqdb_demo.cpp.

Member Function Documentation

◆ GetIndex()

const int CSeqDBDemo_Thread::GetIndex ( void  ) const

Definition at line 521 of file seqdb_demo.cpp.

References m_Index.

◆ Init()

static void CSeqDBDemo_Thread::Init ( CSeqDB db,
bool  oid_shuffle,
bool  use_ambigs 
)
inlinestatic

◆ IsRunning()

bool CSeqDBDemo_Thread::IsRunning ( void  ) const
inline

Definition at line 302 of file seqdb_demo.cpp.

References m_Running.

◆ Main()

void * CSeqDBDemo_Thread::Main ( void  )
virtual

Derived (user-created) class must provide a real thread function.

Implements CThread.

Definition at line 421 of file seqdb_demo.cpp.

References done, CSeqDB::eOidRange, CSeqDB::GetNextOIDChunk(), ITERATE, letter(), m_AtATime, m_Index, sm_oid_shuffle, sm_oid_state, sm_sp, sm_use_ambigs, and x_UseOID().

◆ OnExit()

void CSeqDBDemo_Thread::OnExit ( void  )
virtual

Override this to execute finalization code.

Unlike destructor, this code will be executed before thread termination and as a part of the thread.

Reimplemented from CThread.

Definition at line 506 of file seqdb_demo.cpp.

References m_Running, m_Temp, and NULL.

◆ x_UseOID()

long CSeqDBDemo_Thread::x_UseOID ( int  letter,
int  oid 
)
inlineprivate

Use this OID as part of the set.

Definition at line 322 of file seqdb_demo.cpp.

References buffer, CSeqDB::GetAmbigSeq(), CSeqDB::GetSequence(), i, kSeqDBNuclNcbiNA8, letter(), mask, NULL, CSeqDB::RetAmbigSeq(), CSeqDB::RetSequence(), sm_is_protein, sm_sp, and sm_use_ambigs.

Referenced by Main().

Member Data Documentation

◆ m_AtATime

const int CSeqDBDemo_Thread::m_AtATime
private

Definition at line 315 of file seqdb_demo.cpp.

Referenced by Main().

◆ m_Index

const int CSeqDBDemo_Thread::m_Index
private

Definition at line 314 of file seqdb_demo.cpp.

Referenced by GetIndex(), and Main().

◆ m_MaxLength

const int CSeqDBDemo_Thread::m_MaxLength
private

Definition at line 316 of file seqdb_demo.cpp.

◆ m_Running

bool CSeqDBDemo_Thread::m_Running
private

Definition at line 317 of file seqdb_demo.cpp.

Referenced by IsRunning(), and OnExit().

◆ m_Temp

char* CSeqDBDemo_Thread::m_Temp
private

Definition at line 318 of file seqdb_demo.cpp.

Referenced by OnExit().

◆ sm_is_protein

bool CSeqDBDemo_Thread::sm_is_protein = false
staticprivate

Definition at line 309 of file seqdb_demo.cpp.

Referenced by Init(), and x_UseOID().

◆ sm_oid_shuffle

bool CSeqDBDemo_Thread::sm_oid_shuffle = false
staticprivate

Definition at line 310 of file seqdb_demo.cpp.

Referenced by Init(), and Main().

◆ sm_oid_state

int CSeqDBDemo_Thread::sm_oid_state = 0
staticprivate

Definition at line 312 of file seqdb_demo.cpp.

Referenced by Main().

◆ sm_sp

CSeqDB * CSeqDBDemo_Thread::sm_sp = NULL
staticprivate

Definition at line 308 of file seqdb_demo.cpp.

Referenced by Init(), Main(), and x_UseOID().

◆ sm_use_ambigs

bool CSeqDBDemo_Thread::sm_use_ambigs = false
staticprivate

Definition at line 311 of file seqdb_demo.cpp.

Referenced by Init(), Main(), and x_UseOID().


The documentation for this class was generated from the following file:
Modified on Mon Mar 04 05:10:08 2024 by modify_doxy.py rev. 669887