CHeapScope Class Reference

Search Toolkit Book for CHeapScope

#include <objmgr/impl/heap_scope.hpp>

Collaboration diagram for CHeapScope:

Public Member Functions
	CHeapScope (void)
	CHeapScope (CScope &scope)
	CHeapScope (CScope *scope)
bool	IsSet (void) const
bool	IsNull (void) const
	DECLARE_OPERATOR_BOOL_REF (m_Scope)
bool	operator== (const CHeapScope &scope) const
bool	operator!= (const CHeapScope &scope) const
bool	operator< (const CHeapScope &scope) const
CScope &	GetScope (void) const
CScope *	GetScopeOrNull (void) const
	operator CScope & (void) const
	operator CScope * (void) const
CScope &	operator* (void) const
CScope_Impl *	GetImpl (void) const
	operator CScope_Impl * (void) const
CScope_Impl *	operator-> (void) const
void	Set (CScope *scope)
void	Reset (void)
void	Swap (CHeapScope &scope)

Private Attributes
CRef< CObject >	m_Scope

Detailed Description

Definition at line 53 of file heap_scope.hpp.

Constructor & Destructor Documentation

CHeapScope() [1/3]

CHeapScope::CHeapScope ( void  )

inline

Definition at line 56 of file heap_scope.hpp.

CHeapScope() [2/3]

CHeapScope::CHeapScope ( CScope &  scope )

inlineexplicit

Definition at line 59 of file heap_scope.hpp.

References Set().

CHeapScope() [3/3]

CHeapScope::CHeapScope ( CScope *  scope )

inlineexplicit

Definition at line 63 of file heap_scope.hpp.

References Set().

Member Function Documentation

DECLARE_OPERATOR_BOOL_REF()

CHeapScope::DECLARE_OPERATOR_BOOL_REF

(

m_Scope

)

GetImpl()

CScope_Impl * CHeapScope::GetImpl

(

void

)

const

Definition at line 80 of file heap_scope.cpp.

References CRef< C, Locker >::GetPointer(), GetScope(), and CScope::m_Impl.

Referenced by operator CScope_Impl *(), operator->(), and CTSE_Handle::x_GetScopeImpl().

GetScope()

CScope & CHeapScope::GetScope

(

void

)

const

Definition at line 68 of file heap_scope.cpp.

References CRef< C, Locker >::GetNCObject(), and m_Scope.

Referenced by CScope_Mapper_Sequence_Info::CollectSynonyms(), CSeq_loc_Mapper::CSeq_loc_Mapper(), GetImpl(), CBioseq_CI::GetScope(), CAnnot_Collector::GetScope(), CTSE_Handle::GetScope(), CScope_Mapper_Sequence_Info::GetSequenceLength(), CScope_Mapper_Sequence_Info::GetSequenceType(), operator CScope &(), operator CScope *(), operator*(), and CSeq_loc_Mapper::x_AddVirtualBioseq().

GetScopeOrNull()

CScope * CHeapScope::GetScopeOrNull

(

void

)

const

Definition at line 74 of file heap_scope.cpp.

References CRef< C, Locker >::GetNCPointerOrNull(), and m_Scope.

Referenced by CSeqVector_CI::CanGetRange(), CSeqMap_CI::GetScope(), CSeqVector_CI::HasZeroGapBefore(), CSeqVector::x_GetPacked2naSeqData(), CSeqVector::x_GetPacked4naSeqData(), CSeqVector::x_GetPacked8SeqData(), CSeqVector_CI::x_GetSize(), CSeq_loc_Mapper::x_InitializeSeqMap(), and CSeqVector_CI::x_InitSeg().

IsNull()

bool CHeapScope::IsNull ( void  ) const

inline

Definition at line 73 of file heap_scope.hpp.

References m_Scope.

Referenced by CScope_Mapper_Sequence_Info::CollectSynonyms(), CScopeSource::GetScope(), CScope_Mapper_Sequence_Info::GetSequenceLength(), and CScope_Mapper_Sequence_Info::GetSequenceType().

IsSet()

bool CHeapScope::IsSet ( void  ) const

inline

Definition at line 69 of file heap_scope.hpp.

References m_Scope, and CRef< C, Locker >::NotEmpty().

operator CScope &()

CHeapScope::operator CScope & ( void  ) const

inline

Definition at line 96 of file heap_scope.hpp.

References GetScope().

operator CScope *()

CHeapScope::operator CScope * ( void  ) const

inline

Definition at line 100 of file heap_scope.hpp.

References GetScope().

operator CScope_Impl *()

CHeapScope::operator CScope_Impl * ( void  ) const

inline

Definition at line 112 of file heap_scope.hpp.

References GetImpl().

operator!=()

bool CHeapScope::operator!= ( const CHeapScope &  scope ) const

inline

Definition at line 84 of file heap_scope.hpp.

References m_Scope.

operator*()

CScope& CHeapScope::operator* ( void  ) const

inline

Definition at line 104 of file heap_scope.hpp.

References GetScope().

operator->()

CScope_Impl* CHeapScope::operator-> ( void  ) const

inline

Definition at line 116 of file heap_scope.hpp.

References GetImpl().

operator<()

bool CHeapScope::operator< ( const CHeapScope &  scope ) const

inline

Definition at line 88 of file heap_scope.hpp.

References m_Scope.

operator==()

bool CHeapScope::operator== ( const CHeapScope &  scope ) const

inline

Definition at line 80 of file heap_scope.hpp.

References m_Scope.

Reset()

void CHeapScope::Reset ( void  )

inline

Definition at line 123 of file heap_scope.hpp.

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

Referenced by CTSE_Handle::Reset().

Set()

void CHeapScope::Set

(

CScope *

scope

)

Definition at line 56 of file heap_scope.cpp.

References _ASSERT, m_Scope, and CRef< C, Locker >::Reset().

Referenced by CHeapScope(), CScopeSource::GetScope(), and CScopeSource::New().

Swap()

void CHeapScope::Swap ( CHeapScope &  scope )

inline

Definition at line 128 of file heap_scope.hpp.

References m_Scope, and CRef< C, Locker >::Swap().

Referenced by CTSE_Handle::Swap().

Member Data Documentation

m_Scope

CRef<CObject> CHeapScope::m_Scope

private

Definition at line 135 of file heap_scope.hpp.

Referenced by GetScope(), GetScopeOrNull(), IsNull(), IsSet(), operator!=(), operator<(), operator==(), Reset(), and Swap().

---

The documentation for this class was generated from the following files:

• include/objmgr/impl/heap_scope.hpp
• src/objmgr/heap_scope.cpp