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

Search Toolkit Book for CFeatTreeIndex

+ Inheritance diagram for CFeatTreeIndex:
+ Collaboration diagram for CFeatTreeIndex:

Public Types

typedef pair< CSeqFeatData::ESubtype, boolTParentKey
typedef map< TParentKey, CRef< CFeatTreeParentTypeIndex > > TIndex
- 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...

Public Member Functions

TRangeArray & GetIndex (CSeqFeatData::ESubtype type, bool by_product, const TInfoArray &feats)
TRangeArray & GetIndex (const STypeLink &link, const TInfoArray &feats)
- 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

TIndex m_Index
TCanonicalIdsMap m_CanonicalIds


class CFeatTree

Additional Inherited Members

- 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 1890 of file feature.cpp.

Member Typedef Documentation

◆ TIndex

typedef map<TParentKey, CRef<CFeatTreeParentTypeIndex> > CFeatTreeIndex::TIndex

Definition at line 1894 of file feature.cpp.

◆ TParentKey

Definition at line 1893 of file feature.cpp.

Member Function Documentation

◆ GetIndex() [1/2]

TRangeArray& CFeatTreeIndex::GetIndex ( const STypeLink link,
const TInfoArray &  feats 

Definition at line 1907 of file feature.cpp.

References GetIndex(), STypeLink::m_ByProduct, and STypeLink::m_ParentType.

◆ GetIndex() [2/2]

TRangeArray& CFeatTreeIndex::GetIndex ( CSeqFeatData::ESubtype  type,
bool  by_product,
const TInfoArray &  feats 

Friends And Related Function Documentation

◆ CFeatTree

friend class CFeatTree

Definition at line 1912 of file feature.cpp.

Member Data Documentation

◆ m_CanonicalIds

TCanonicalIdsMap CFeatTreeIndex::m_CanonicalIds

◆ m_Index

TIndex CFeatTreeIndex::m_Index

Definition at line 1914 of file feature.cpp.

Referenced by GetIndex().

The documentation for this class was generated from the following file:
Modified on Mon Jul 22 05:08:18 2024 by rev. 669887