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

Search Toolkit Book for CCluster

+ Inheritance diagram for CCluster:
+ Collaboration diagram for CCluster:

Public Member Functions

 CCluster (unsigned int cluster_id)
 
unsigned int GetClusterId ()
 
CRef< CClusterSeq > & GetRefSeq ()
 
const stringGetRefSeqId ()
 
void SetRefSeq (CRef< CClusterSeq > &r)
 
const vector< CRef< CClusterSeq > > & GetMemSeqs ()
 
void AddMemSeq (CRef< CClusterSeq > &m)
 
int64_t GetRefSeqOid ()
 
- 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
 

Private Attributes

unsigned int m_ClusterId
 
CRef< CClusterSeqm_RefSeq
 
vector< CRef< CClusterSeq > > m_MemSeqs
 

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 91 of file makeclusterdb.cpp.

Constructor & Destructor Documentation

◆ CCluster()

CCluster::CCluster ( unsigned int  cluster_id)
inline

Definition at line 93 of file makeclusterdb.cpp.

Member Function Documentation

◆ AddMemSeq()

void CCluster::AddMemSeq ( CRef< CClusterSeq > &  m)
inline

Definition at line 100 of file makeclusterdb.cpp.

References m_MemSeqs.

Referenced by CMakeClusterDBApp::x_ProcessInputFile().

◆ GetClusterId()

unsigned int CCluster::GetClusterId ( )
inline

Definition at line 94 of file makeclusterdb.cpp.

References m_ClusterId.

◆ GetMemSeqs()

const vector<CRef<CClusterSeq> >& CCluster::GetMemSeqs ( )
inline

Definition at line 99 of file makeclusterdb.cpp.

References m_MemSeqs.

Referenced by CClusterDBSource::GetNext().

◆ GetRefSeq()

CRef<CClusterSeq>& CCluster::GetRefSeq ( )
inline

Definition at line 95 of file makeclusterdb.cpp.

References m_RefSeq.

Referenced by CClusterDBSource::GetNext().

◆ GetRefSeqId()

const string& CCluster::GetRefSeqId ( void  )
inline

◆ GetRefSeqOid()

int64_t CCluster::GetRefSeqOid ( )
inline

◆ SetRefSeq()

void CCluster::SetRefSeq ( CRef< CClusterSeq > &  r)
inline

Definition at line 97 of file makeclusterdb.cpp.

References m_RefSeq, r(), and CRef< C, Locker >::Reset().

Referenced by CMakeClusterDBApp::x_ProcessInputFile().

Member Data Documentation

◆ m_ClusterId

unsigned int CCluster::m_ClusterId
private

Definition at line 110 of file makeclusterdb.cpp.

Referenced by GetClusterId().

◆ m_MemSeqs

vector<CRef<CClusterSeq> > CCluster::m_MemSeqs
private

Definition at line 112 of file makeclusterdb.cpp.

Referenced by AddMemSeq(), and GetMemSeqs().

◆ m_RefSeq

CRef<CClusterSeq> CCluster::m_RefSeq
private

Definition at line 111 of file makeclusterdb.cpp.

Referenced by GetRefSeq(), GetRefSeqId(), GetRefSeqOid(), and SetRefSeq().


The documentation for this class was generated from the following file:
Modified on Wed Jun 19 17:07:35 2024 by modify_doxy.py rev. 669887