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

Search Toolkit Book for CCachedTipHandle

#include "seqgraphic_pane.hpp"
(Private to src/gui/widgets/seq_graphic.)

+ Inheritance diagram for CCachedTipHandle:
+ Collaboration diagram for CCachedTipHandle:

Public Member Functions

 CCachedTipHandle (const string &t_name, objects::CScope &scope)
 
void Add (CObject &obj)
 
const stringGetParentTrackName () const
 
bool HasMatches (const CObject &object, objects::CScope &scope) const
 
- 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

CObjectIndex m_ObjIndex
 
string m_ParentTrackName
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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 61 of file seqgraphic_pane.hpp.

Constructor & Destructor Documentation

CCachedTipHandle::CCachedTipHandle ( const string t_name,
objects::CScope &  scope 
)
inline

Definition at line 64 of file seqgraphic_pane.hpp.

References CObjectIndex::Clear(), and m_ObjIndex.

Member Function Documentation

void CCachedTipHandle::Add ( CObject obj)
inline

Definition at line 70 of file seqgraphic_pane.hpp.

References CObjectIndex::Add(), m_ObjIndex, and NULL.

Referenced by CSeqGraphicPane::OnTipAdded().

const string& CCachedTipHandle::GetParentTrackName ( ) const
inline
bool CCachedTipHandle::HasMatches ( const CObject object,
objects::CScope &  scope 
) const
inline

Member Data Documentation

CObjectIndex CCachedTipHandle::m_ObjIndex
private

Definition at line 79 of file seqgraphic_pane.hpp.

Referenced by Add(), CCachedTipHandle(), and HasMatches().

string CCachedTipHandle::m_ParentTrackName
private

Definition at line 80 of file seqgraphic_pane.hpp.

Referenced by GetParentTrackName().


The documentation for this class was generated from the following file:
Modified on Sat Apr 21 13:52:52 2018 by modify_doxy.py rev. 546573