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

Search Toolkit Book for CSeq_id_Giim_Tree

#include "seq_id_tree.hpp"
(Private to src/objects/seq.)

+ Inheritance diagram for CSeq_id_Giim_Tree:
+ Collaboration diagram for CSeq_id_Giim_Tree:

Public Member Functions

 CSeq_id_Giim_Tree (CSeq_id_Mapper *mapper)
 
 ~CSeq_id_Giim_Tree (void)
 
virtual bool Empty (void) const
 
virtual CSeq_id_Handle FindInfo (const CSeq_id &id) const
 
virtual CSeq_id_Handle FindOrCreate (const CSeq_id &id)
 
virtual void FindMatchStr (const string &sid, TSeq_id_MatchList &id_list) const
 
virtual size_t Dump (CNcbiOstream &out, CSeq_id::E_Choice type, int details) const
 
- Public Member Functions inherited from CSeq_id_Which_Tree
 CSeq_id_Which_Tree (CSeq_id_Mapper *mapper)
 
virtual ~CSeq_id_Which_Tree (void)
 
virtual CSeq_id_Handle GetGiHandle (TGi gi)
 
virtual void DropInfo (const CSeq_id_Info *info)
 
virtual bool HaveMatch (const CSeq_id_Handle &id) const
 
virtual void FindMatch (const CSeq_id_Handle &id, TSeq_id_MatchList &id_list) const
 
virtual bool Match (const CSeq_id_Handle &h1, const CSeq_id_Handle &h2) const
 
virtual bool IsBetterVersion (const CSeq_id_Handle &h1, const CSeq_id_Handle &h2) const
 
virtual bool HaveReverseMatch (const CSeq_id_Handle &id) const
 
virtual void FindReverseMatch (const CSeq_id_Handle &id, TSeq_id_MatchList &id_list)
 
- 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 Types

typedef vector< CSeq_id_Info * > TGiimList
 
typedef map< TPacked, TGiimListTIdMap
 

Private Member Functions

virtual void x_Unindex (const CSeq_id_Info *info)
 
CSeq_id_Infox_FindInfo (const CGiimport_id &gid) const
 

Private Attributes

TIdMap m_IdMap
 

Additional Inherited Members

- Public Types inherited from CSeq_id_Which_Tree
typedef set< CSeq_id_HandleTSeq_id_MatchList
 
- 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 CSeq_id_Which_Tree
static void Initialize (CSeq_id_Mapper *mapper, vector< CRef< CSeq_id_Which_Tree > > &v)
 
- 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 Types inherited from CSeq_id_Which_Tree
typedef CSeq_id_Info::TPacked TPacked
 
typedef CFastMutex TTreeLock
 
typedef TTreeLock::TReadLockGuard TReadLockGuard
 
typedef TTreeLock::TWriteLockGuard TWriteLockGuard
 
- Protected Member Functions inherited from CSeq_id_Which_Tree
CSeq_id_InfoCreateInfo (CSeq_id::E_Choice type)
 
CSeq_id_InfoCreateInfo (const CSeq_id &id)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Static Protected Member Functions inherited from CSeq_id_Which_Tree
static const CSeq_id_InfoGetInfo (const CSeq_id_Handle &id)
 
static const CSeq_idGetSeqId (const CSeq_id_Info *info)
 
- Protected Attributes inherited from CSeq_id_Which_Tree
TTreeLock m_TreeLock
 
CSeq_id_Mapperm_Mapper
 

Detailed Description

Definition at line 938 of file seq_id_tree.hpp.

Member Typedef Documentation

◆ TGiimList

typedef vector<CSeq_id_Info*> CSeq_id_Giim_Tree::TGiimList
private

Definition at line 961 of file seq_id_tree.hpp.

◆ TIdMap

Definition at line 962 of file seq_id_tree.hpp.

Constructor & Destructor Documentation

◆ CSeq_id_Giim_Tree()

CSeq_id_Giim_Tree::CSeq_id_Giim_Tree ( CSeq_id_Mapper mapper)

Definition at line 2874 of file seq_id_tree.cpp.

◆ ~CSeq_id_Giim_Tree()

CSeq_id_Giim_Tree::~CSeq_id_Giim_Tree ( void  )

Definition at line 2880 of file seq_id_tree.cpp.

Member Function Documentation

◆ Dump()

size_t CSeq_id_Giim_Tree::Dump ( CNcbiOstream out,
CSeq_id::E_Choice  type,
int  details 
) const
virtual

◆ Empty()

bool CSeq_id_Giim_Tree::Empty ( void  ) const
virtual

Implements CSeq_id_Which_Tree.

Definition at line 2885 of file seq_id_tree.cpp.

References map_checker< Container >::empty(), and m_IdMap.

◆ FindInfo()

CSeq_id_Handle CSeq_id_Giim_Tree::FindInfo ( const CSeq_id id) const
virtual

Implements CSeq_id_Which_Tree.

Definition at line 2909 of file seq_id_tree.cpp.

References _ASSERT, CSeq_id_Which_Tree::m_TreeLock, and x_FindInfo().

◆ FindMatchStr()

void CSeq_id_Giim_Tree::FindMatchStr ( const string sid,
TSeq_id_MatchList id_list 
) const
virtual

◆ FindOrCreate()

CSeq_id_Handle CSeq_id_Giim_Tree::FindOrCreate ( const CSeq_id id)
virtual

◆ x_FindInfo()

CSeq_id_Info * CSeq_id_Giim_Tree::x_FindInfo ( const CGiimport_id gid) const
private

◆ x_Unindex()

void CSeq_id_Giim_Tree::x_Unindex ( const CSeq_id_Info info)
privatevirtual

Member Data Documentation

◆ m_IdMap

TIdMap CSeq_id_Giim_Tree::m_IdMap
private

Definition at line 964 of file seq_id_tree.hpp.

Referenced by Dump(), Empty(), FindMatchStr(), FindOrCreate(), x_FindInfo(), and x_Unindex().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:48 2024 by modify_doxy.py rev. 669887