Search Toolkit Book for CLocObjects_SplitInfo

#include <objmgr/split/object_splitinfo.hpp>

Inheritance diagram for CLocObjects_SplitInfo:

Collaboration diagram for CLocObjects_SplitInfo:

Public Types
typedef vector< CAnnotObject_SplitInfo >	TObjects

typedef TObjects::const_iterator	const_iterator

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
void	Add (const CAnnotObject_SplitInfo &obj)

CNcbiOstream &	Print (CNcbiOstream &out) const

bool	empty (void) const

size_t	size (void) const

void	clear (void)

const_iterator	begin (void) const

const_iterator	end (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

Public Attributes
TObjects	m_Objects

CSize	m_Size

CSeqsRange	m_Location

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

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

Definition at line 132 of file object_splitinfo.hpp.

Member Typedef Documentation

◆ const_iterator

typedef TObjects::const_iterator CLocObjects_SplitInfo::const_iterator

Definition at line 136 of file object_splitinfo.hpp.

◆ TObjects

typedef vector<CAnnotObject_SplitInfo> CLocObjects_SplitInfo::TObjects

Definition at line 135 of file object_splitinfo.hpp.

Member Function Documentation

◆ Add()

void CLocObjects_SplitInfo::Add ( const CAnnotObject_SplitInfo & obj )

Definition at line 91 of file object_splitinfo.cpp.

References CSeqsRange::Add(), CAnnotObject_SplitInfo::m_Location, m_Location, m_Objects, CAnnotObject_SplitInfo::m_Size, and m_Size.

◆ begin()

const_iterator CLocObjects_SplitInfo::begin ( void ) const

inline

Definition at line 155 of file object_splitinfo.hpp.

References m_Objects.

◆ clear()

void CLocObjects_SplitInfo::clear ( void )

inline

Definition at line 149 of file object_splitinfo.hpp.

References CSeqsRange::clear(), CSize::clear(), m_Location, m_Objects, and m_Size.

◆ empty()

bool CLocObjects_SplitInfo::empty ( void ) const

inline

Definition at line 141 of file object_splitinfo.hpp.

References m_Objects.

◆ end()

const_iterator CLocObjects_SplitInfo::end ( void ) const

inline

Definition at line 159 of file object_splitinfo.hpp.

References m_Objects.

◆ Print()

CNcbiOstream & CLocObjects_SplitInfo::Print ( CNcbiOstream & out ) const

Definition at line 99 of file object_splitinfo.cpp.

References m_Size, and out().

◆ size()

size_t CLocObjects_SplitInfo::size ( void ) const

inline

Definition at line 145 of file object_splitinfo.hpp.

References m_Objects.

Member Data Documentation

◆ m_Location

CSeqsRange CLocObjects_SplitInfo::m_Location

Definition at line 167 of file object_splitinfo.hpp.

Referenced by Add(), and clear().

◆ m_Objects

TObjects CLocObjects_SplitInfo::m_Objects

Definition at line 164 of file object_splitinfo.hpp.

Referenced by Add(), begin(), clear(), empty(), end(), and size().

◆ m_Size

CSize CLocObjects_SplitInfo::m_Size

Definition at line 166 of file object_splitinfo.hpp.

Referenced by Add(), clear(), and Print().

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

include/objmgr/split/object_splitinfo.hpp
src/objmgr/split/object_splitinfo.cpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ TObjects

Member Function Documentation

◆ Add()

◆ begin()

◆ clear()

◆ empty()

◆ end()

◆ Print()

◆ size()

Member Data Documentation

◆ m_Location

◆ m_Objects

◆ m_Size