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

Search Toolkit Book for CPriorityTree

#include <objmgr/impl/priority.hpp>

+ Inheritance diagram for CPriorityTree:
+ Collaboration diagram for CPriorityTree:

Public Types

typedef CDataSource_ScopeInfo TLeaf
 
typedef CPriorityNode::TPriority TPriority
 
typedef multimap< TPriority, CPriorityNodeTPriorityMap
 
- 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

 CPriorityTree (void)
 
 CPriorityTree (CScope_Impl &scope, const CPriorityTree &node)
 
 ~CPriorityTree (void)
 
TPriorityMapGetTree (void)
 
const TPriorityMapGetTree (void) const
 
bool Insert (const CPriorityNode &node, TPriority priority)
 
bool Insert (const CPriorityTree &tree, TPriority priority)
 
bool Insert (TLeaf &leaf, TPriority priority)
 
size_t Erase (const TLeaf &leaf)
 
bool IsEmpty (void) const
 
bool HasSeveralNodes (void)
 
void Clear (void)
 
- 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

TPriorityMap m_Map
 

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 94 of file priority.hpp.

Member Typedef Documentation

◆ TLeaf

Definition at line 97 of file priority.hpp.

◆ TPriority

Definition at line 103 of file priority.hpp.

◆ TPriorityMap

Definition at line 104 of file priority.hpp.

Constructor & Destructor Documentation

◆ CPriorityTree() [1/2]

CPriorityTree::CPriorityTree ( void  )

Definition at line 48 of file priority.cpp.

◆ CPriorityTree() [2/2]

CPriorityTree::CPriorityTree ( CScope_Impl scope,
const CPriorityTree node 
)

Definition at line 58 of file priority.cpp.

References multimap_checker< Container >::insert(), ITERATE, and m_Map.

◆ ~CPriorityTree()

CPriorityTree::~CPriorityTree ( void  )

Definition at line 53 of file priority.cpp.

Member Function Documentation

◆ Clear()

void CPriorityTree::Clear ( void  )

Definition at line 110 of file priority.cpp.

References multimap_checker< Container >::clear(), and m_Map.

Referenced by CPriorityNode::Clear(), and CScope_Impl::ResetScope().

◆ Erase()

size_t CPriorityTree::Erase ( const TLeaf leaf)

◆ GetTree() [1/2]

CPriorityTree::TPriorityMap & CPriorityTree::GetTree ( void  )
inline

Definition at line 160 of file priority.hpp.

References m_Map.

Referenced by CScope_Impl::GetConstDS(), and CScope_Impl::GetEditDS().

◆ GetTree() [2/2]

const CPriorityTree::TPriorityMap & CPriorityTree::GetTree ( void  ) const
inline

Definition at line 166 of file priority.hpp.

References m_Map.

◆ HasSeveralNodes()

bool CPriorityTree::HasSeveralNodes ( void  )

Definition at line 116 of file priority.cpp.

Referenced by CScope_Impl::x_GetTSESetWithBioseqAnnots().

◆ Insert() [1/3]

bool CPriorityTree::Insert ( const CPriorityNode node,
TPriority  priority 
)

◆ Insert() [2/3]

bool CPriorityTree::Insert ( const CPriorityTree tree,
TPriority  priority 
)

Definition at line 74 of file priority.cpp.

References Insert().

◆ Insert() [3/3]

bool CPriorityTree::Insert ( TLeaf leaf,
TPriority  priority 
)

◆ IsEmpty()

bool CPriorityTree::IsEmpty ( void  ) const
inline

Definition at line 172 of file priority.hpp.

References multimap_checker< Container >::empty(), and m_Map.

Referenced by CPriorityNode::IsEmpty().

Member Data Documentation

◆ m_Map

TPriorityMap CPriorityTree::m_Map
private

Definition at line 121 of file priority.hpp.

Referenced by Clear(), CPriorityTree(), Erase(), GetTree(), Insert(), and IsEmpty().


The documentation for this class was generated from the following files:
Modified on Sat Jun 22 10:40:52 2024 by modify_doxy.py rev. 669887