NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
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
 
CScopeGetScope (void) const
 
CScopeGetScopeOrNull (void) const
 
 operator CScope & (void) const
 
 operator CScope * (void) const
 
CScopeoperator* (void) const
 
CScope_ImplGetImpl (void) const
 
 operator CScope_Impl * (void) const
 
CScope_Imploperator-> (void) const
 
void Set (CScope *scope)
 
void Reset (void)
 
void Swap (CHeapScope &scope)
 

Private Attributes

CRef< CObjectm_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

◆ GetScope()

CScope & CHeapScope::GetScope ( void  ) const

◆ GetScopeOrNull()

CScope * CHeapScope::GetScopeOrNull ( void  ) const

◆ IsNull()

bool CHeapScope::IsNull ( void  ) const
inline

◆ 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

The documentation for this class was generated from the following files:
Modified on Mon May 20 05:02:52 2024 by modify_doxy.py rev. 669887