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

Search Toolkit Book for CScopeInfo_Base

#include <objmgr/tse_handle.hpp>

+ Inheritance diagram for CScopeInfo_Base:
+ Collaboration diagram for CScopeInfo_Base:

Public Types

typedef CSeq_id_Handle TIndexId
 
typedef vector< TIndexIdTIndexIds
 
- 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

 CScopeInfo_Base (void)
 
 CScopeInfo_Base (const CTSE_ScopeUserLock &tse, const CTSE_Info_Object &info)
 
 CScopeInfo_Base (const CTSE_Handle &tse, const CTSE_Info_Object &info)
 
 ~CScopeInfo_Base (void)
 
bool IsDetached (void) const
 
bool IsAttached (void) const
 
bool HasObject (void) const
 
bool HasObject (const CTSE_Info_Object &info) const
 
virtual const TIndexIdsGetIndexIds (void) const
 
bool IsTemporary (void) const
 
CTSE_ScopeInfox_GetTSE_ScopeInfo (void) const
 
const CTSE_HandleGetTSE_Handle (void) const
 
CScope_Implx_GetScopeImpl (void) const
 
const CTSE_Info_ObjectGetObjectInfo_Base (void) 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
 

Protected Types

enum  ECheckFlags {
  fAllowZero = 0x00 , fForceZero = 0x01 , fForbidZero = 0x02 , fAllowInfo = 0x00 ,
  fForceInfo = 0x10 , fForbidInfo = 0x20
}
 
typedef int TCheckFlags
 

Protected Member Functions

virtual void x_AttachTSE (CTSE_ScopeInfo *tse)
 
virtual void x_DetachTSE (CTSE_ScopeInfo *tse)
 
void x_ResetTSE_Lock (void)
 
void x_SetTSE_Lock (const CTSE_ScopeUserLock &tse, const CTSE_Info_Object &info)
 
void x_SetTSE_Handle (const CTSE_Handle &tse)
 
void AddInfoLock (void)
 
void RemoveInfoLock (void)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Member Functions

 CScopeInfo_Base (const CScopeInfo_Base &)
 
void operator= (const CScopeInfo_Base &)
 

Private Attributes

CTSE_ScopeInfom_TSE_ScopeInfo
 
atomic< Uint8m_LockCounter
 
CTSE_Handle m_TSE_Handle
 
CConstRef< CObjectm_ObjectInfo
 
atomic< boolm_TSE_HandleAssigned
 
atomic< boolm_ObjectInfoAssigned
 
CRef< CObjectm_DetachedInfo
 

Friends

class CTSE_ScopeInfo
 
class CScopeInfoLocker
 

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...
 

Detailed Description

Definition at line 392 of file tse_handle.hpp.

Member Typedef Documentation

◆ TCheckFlags

typedef int CScopeInfo_Base::TCheckFlags
protected

Definition at line 561 of file tse_handle.hpp.

◆ TIndexId

Definition at line 420 of file tse_handle.hpp.

◆ TIndexIds

Definition at line 421 of file tse_handle.hpp.

Member Enumeration Documentation

◆ ECheckFlags

Enumerator
fAllowZero 
fForceZero 
fForbidZero 
fAllowInfo 
fForceInfo 
fForbidInfo 

Definition at line 553 of file tse_handle.hpp.

Constructor & Destructor Documentation

◆ CScopeInfo_Base() [1/4]

CScopeInfo_Base::CScopeInfo_Base ( void  )

Definition at line 435 of file tse_handle.cpp.

◆ CScopeInfo_Base() [2/4]

CScopeInfo_Base::CScopeInfo_Base ( const CTSE_ScopeUserLock tse,
const CTSE_Info_Object info 
)

Definition at line 444 of file tse_handle.cpp.

References _ASSERT, HasObject(), and info.

◆ CScopeInfo_Base() [3/4]

CScopeInfo_Base::CScopeInfo_Base ( const CTSE_Handle tse,
const CTSE_Info_Object info 
)

Definition at line 458 of file tse_handle.cpp.

References _ASSERT, HasObject(), and info.

◆ ~CScopeInfo_Base()

CScopeInfo_Base::~CScopeInfo_Base ( void  )

Definition at line 472 of file tse_handle.cpp.

◆ CScopeInfo_Base() [4/4]

CScopeInfo_Base::CScopeInfo_Base ( const CScopeInfo_Base )
private

Member Function Documentation

◆ AddInfoLock()

void CScopeInfo_Base::AddInfoLock ( void  )
inlineprotected

Definition at line 569 of file tse_handle.hpp.

References m_LockCounter.

◆ GetIndexIds()

const CScopeInfo_Base::TIndexIds * CScopeInfo_Base::GetIndexIds ( void  ) const
virtual

Reimplemented in CBioseq_ScopeInfo.

Definition at line 483 of file tse_handle.cpp.

Referenced by IsTemporary().

◆ GetObjectInfo_Base()

const CTSE_Info_Object& CScopeInfo_Base::GetObjectInfo_Base ( void  ) const
inline

◆ GetTSE_Handle()

const CTSE_Handle& CScopeInfo_Base::GetTSE_Handle ( void  ) const
inline

◆ HasObject() [1/2]

bool CScopeInfo_Base::HasObject ( const CTSE_Info_Object info) const
inline

Definition at line 415 of file tse_handle.hpp.

References GetObjectInfo_Base(), HasObject(), and info.

◆ HasObject() [2/2]

bool CScopeInfo_Base::HasObject ( void  ) const
inline

◆ IsAttached()

bool CScopeInfo_Base::IsAttached ( void  ) const
inline

◆ IsDetached()

bool CScopeInfo_Base::IsDetached ( void  ) const
inline

◆ IsTemporary()

bool CScopeInfo_Base::IsTemporary ( void  ) const
inline

Definition at line 432 of file tse_handle.hpp.

References GetIndexIds().

◆ operator=()

void CScopeInfo_Base::operator= ( const CScopeInfo_Base )
private

◆ RemoveInfoLock()

void CScopeInfo_Base::RemoveInfoLock ( void  )
inlineprotected

Definition at line 573 of file tse_handle.hpp.

References m_LockCounter, and x_ResetTSE_Lock().

◆ x_AttachTSE()

void CScopeInfo_Base::x_AttachTSE ( CTSE_ScopeInfo tse)
protectedvirtual

Reimplemented in CBioseq_ScopeInfo.

Definition at line 554 of file tse_handle.cpp.

References _ASSERT, IsDetached(), and m_TSE_ScopeInfo.

Referenced by CBioseq_ScopeInfo::x_AttachTSE().

◆ x_DetachTSE()

void CScopeInfo_Base::x_DetachTSE ( CTSE_ScopeInfo tse)
protectedvirtual

Reimplemented in CBioseq_ScopeInfo.

Definition at line 563 of file tse_handle.cpp.

References _ASSERT, IsDetached(), m_TSE_Handle, and m_TSE_ScopeInfo.

Referenced by CBioseq_ScopeInfo::x_DetachTSE().

◆ x_GetScopeImpl()

CScope_Impl & CScopeInfo_Base::x_GetScopeImpl ( void  ) const

◆ x_GetTSE_ScopeInfo()

CTSE_ScopeInfo& CScopeInfo_Base::x_GetTSE_ScopeInfo ( void  ) const
inline

◆ x_ResetTSE_Lock()

void CScopeInfo_Base::x_ResetTSE_Lock ( void  )
protected

Definition at line 539 of file tse_handle.cpp.

References m_LockCounter, m_TSE_Handle, m_TSE_HandleAssigned, and CTSE_Handle::Swap().

Referenced by RemoveInfoLock().

◆ x_SetTSE_Handle()

void CScopeInfo_Base::x_SetTSE_Handle ( const CTSE_Handle tse)
protected

◆ x_SetTSE_Lock()

void CScopeInfo_Base::x_SetTSE_Lock ( const CTSE_ScopeUserLock tse,
const CTSE_Info_Object info 
)
protected

Friends And Related Function Documentation

◆ CScopeInfoLocker

friend class CScopeInfoLocker
friend

Definition at line 547 of file tse_handle.hpp.

◆ CTSE_ScopeInfo

friend class CTSE_ScopeInfo
friend

Definition at line 546 of file tse_handle.hpp.

Member Data Documentation

◆ m_DetachedInfo

CRef<CObject> CScopeInfo_Base::m_DetachedInfo
private

Definition at line 590 of file tse_handle.hpp.

Referenced by CTSE_ScopeInfo::x_CheckAdded(), and CTSE_ScopeInfo::x_RestoreAdded().

◆ m_LockCounter

atomic<Uint8> CScopeInfo_Base::m_LockCounter
private

◆ m_ObjectInfo

CConstRef<CObject> CScopeInfo_Base::m_ObjectInfo
private

Definition at line 587 of file tse_handle.hpp.

Referenced by x_SetTSE_Lock().

◆ m_ObjectInfoAssigned

atomic<bool> CScopeInfo_Base::m_ObjectInfoAssigned
private

Definition at line 589 of file tse_handle.hpp.

Referenced by HasObject(), and x_SetTSE_Lock().

◆ m_TSE_Handle

CTSE_Handle CScopeInfo_Base::m_TSE_Handle
private

◆ m_TSE_HandleAssigned

atomic<bool> CScopeInfo_Base::m_TSE_HandleAssigned
private

Definition at line 588 of file tse_handle.hpp.

Referenced by x_ResetTSE_Lock(), x_SetTSE_Handle(), and x_SetTSE_Lock().

◆ m_TSE_ScopeInfo

CTSE_ScopeInfo* CScopeInfo_Base::m_TSE_ScopeInfo
private

The documentation for this class was generated from the following files:
Modified on Sat May 25 14:18:04 2024 by modify_doxy.py rev. 669887