Search Toolkit Book for CTaxTreeDS_ObjMgr

#include <gui/widgets/tax_tree/tax_tree_ds.hpp>

Inheritance diagram for CTaxTreeDS_ObjMgr:

Collaboration diagram for CTaxTreeDS_ObjMgr:

Public Member Functions
	CTaxTreeDS_ObjMgr (objects::CScope &scope, const TUidVec &ids)

void	GetTaxMap (TTaxMap &taxmap)

void	GetUids (TUidVec &gis)

const TUidVec &	GetUids () const

void	GetTitle (const objects::CSeq_id &uids, string *title) const

void	GetTitle (const objects::ITaxon1Node &node, string *title) const

objects::ITreeIterator &	GetIterator (EDisplayMode mode=eDisplay_Default)

const CRef< objects::CScope > &	GetScope (void)

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

Private Member Functions
void	x_Init (void)

Private Attributes
TUidVec	m_Ids

CRef< objects::CScope >	m_Scope

objects::CTaxon1	m_TaxCache

EDisplayMode	m_Mode

CRef< objects::ITreeIterator >	m_Iter

Additional Inherited Members
Public Types inherited from CTaxTreeDataSource
enum	EDisplayMode { eDisplay_All , eDisplay_Best , eDisplay_Blast , eDisplay_Default = eDisplay_All }

typedef CConstRef< objects::CSeq_id >	TUid

typedef vector< TUid >	TUidVec

typedef map< TTaxId, TUidVec >	TTaxMap

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

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 100 of file tax_tree_ds.hpp.

Constructor & Destructor Documentation

◆ CTaxTreeDS_ObjMgr()

CTaxTreeDS_ObjMgr::CTaxTreeDS_ObjMgr	(	objects::CScope &	scope,
		const TUidVec &	ids
	)

Definition at line 47 of file tax_tree_ds.cpp.

References eUnknown, GetTaxMap(), ITERATE, m_TaxCache, NCBI_THROW, and map_checker< Container >::size().

Member Function Documentation

◆ GetIterator()

ITreeIterator & CTaxTreeDS_ObjMgr::GetIterator ( EDisplayMode mode = eDisplay_Default )

virtual

Implements CTaxTreeDataSource.

Definition at line 78 of file tax_tree_ds.cpp.

References CTaxTreeDataSource::eDisplay_All, CTaxTreeDataSource::eDisplay_Best, CTaxTreeDataSource::eDisplay_Blast, CTaxon1::eIteratorMode_Best, CTaxon1::eIteratorMode_Blast, CTaxon1::eIteratorMode_Default, m_Iter, m_Mode, m_TaxCache, and CRef< C, Locker >::Reset().

◆ GetScope()

const CRef< objects::CScope > & CTaxTreeDS_ObjMgr::GetScope ( void )

virtual

Implements CTaxTreeDataSource.

Definition at line 179 of file tax_tree_ds.cpp.

References m_Scope.

◆ GetTaxMap()

void CTaxTreeDS_ObjMgr::GetTaxMap ( TTaxMap & taxmap )

virtual

Implements CTaxTreeDataSource.

Definition at line 104 of file tax_tree_ds.cpp.

References CLabel::eDefault, CBioseq_Handle::GetBioseqCore(), CSeq_id_Base::GetGi(), CLabel::GetLabel(), GetTaxId(), GetUids(), Info(), set< Key, Compare >::insert(), CSeq_id_Base::IsGi(), ITERATE, LOG_POST, m_Scope, m_TaxCache, str(), TAX_ID_FROM, and ZERO_TAX_ID.

Referenced by CTaxTreeDS_ObjMgr().

◆ GetTitle() [1/2]

void CTaxTreeDS_ObjMgr::GetTitle	(	const objects::CSeq_id &	uids,
		string *	title
	)		const

virtual

Implements CTaxTreeDataSource.

◆ GetTitle() [2/2]

void CTaxTreeDS_ObjMgr::GetTitle	(	const objects::ITaxon1Node &	node,
		string *	title
	)		const

virtual

Implements CTaxTreeDataSource.

◆ GetUids() [1/2]

const CTaxTreeDS_ObjMgr::TUidVec & CTaxTreeDS_ObjMgr::GetUids ( ) const

virtual

Implements CTaxTreeDataSource.

Definition at line 148 of file tax_tree_ds.cpp.

References m_Ids.

Referenced by GetTaxMap().

◆ GetUids() [2/2]

void CTaxTreeDS_ObjMgr::GetUids ( TUidVec & gis )

virtual

Implements CTaxTreeDataSource.

Definition at line 142 of file tax_tree_ds.cpp.

References m_Ids.

◆ x_Init()

void CTaxTreeDS_ObjMgr::x_Init ( void )

private

Member Data Documentation

◆ m_Ids

TUidVec CTaxTreeDS_ObjMgr::m_Ids

private

Definition at line 129 of file tax_tree_ds.hpp.

Referenced by GetUids().

◆ m_Iter

CRef<objects::ITreeIterator> CTaxTreeDS_ObjMgr::m_Iter

mutableprivate

Definition at line 142 of file tax_tree_ds.hpp.

Referenced by GetIterator().

◆ m_Mode

EDisplayMode CTaxTreeDS_ObjMgr::m_Mode

private

Definition at line 139 of file tax_tree_ds.hpp.

Referenced by GetIterator().

◆ m_Scope

CRef<objects::CScope> CTaxTreeDS_ObjMgr::m_Scope

mutableprivate

Definition at line 132 of file tax_tree_ds.hpp.

Referenced by GetScope(), and GetTaxMap().

◆ m_TaxCache

objects::CTaxon1 CTaxTreeDS_ObjMgr::m_TaxCache

private

Definition at line 135 of file tax_tree_ds.hpp.

Referenced by CTaxTreeDS_ObjMgr(), GetIterator(), and GetTaxMap().

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

include/gui/widgets/tax_tree/tax_tree_ds.hpp
src/gui/widgets/tax_tree/tax_tree_ds.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CTaxTreeDS_ObjMgr()

Member Function Documentation

◆ GetIterator()

◆ GetScope()

◆ GetTaxMap()

◆ GetTitle() [1/2]

◆ GetTitle() [2/2]

◆ GetUids() [1/2]

◆ GetUids() [2/2]

◆ x_Init()

Member Data Documentation

◆ m_Ids

◆ m_Iter

◆ m_Mode

◆ m_Scope

◆ m_TaxCache