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< TIndexId >	TIndexIds

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< Uint8 >	TCounter
	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 TIndexIds *	GetIndexIds (void) const

bool	IsTemporary (void) const

CTSE_ScopeInfo &	x_GetTSE_ScopeInfo (void) const

const CTSE_Handle &	GetTSE_Handle (void) const

CScope_Impl &	x_GetScopeImpl (void) const

const CTSE_Info_Object &	GetObjectInfo_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...

CObject &	operator= (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_ScopeInfo *	m_TSE_ScopeInfo

atomic< Uint8 >	m_LockCounter

CTSE_Handle	m_TSE_Handle

CConstRef< CObject >	m_ObjectInfo

atomic< bool >	m_TSE_HandleAssigned

atomic< bool >	m_ObjectInfoAssigned

CRef< CObject >	m_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...