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

Search Toolkit Book for CTSE_Info_Object

#include <objmgr/impl/tse_info_object.hpp>

+ Inheritance diagram for CTSE_Info_Object:
+ Collaboration diagram for CTSE_Info_Object:

Public Types

enum  ENeedUpdateAux { kNeedUpdate_bits = 8 }
enum  ENeedUpdate {
  fNeedUpdate_this = (1<<kNeedUpdate_bits)-1 , fNeedUpdate_children = fNeedUpdate_this<<kNeedUpdate_bits , fNeedUpdate_descr = 1<<0 , fNeedUpdate_annot = 1<<1 ,
  fNeedUpdate_seq_data = 1<<2 , fNeedUpdate_core = 1<<3 , fNeedUpdate_assembly = 1<<4 , fNeedUpdate_bioseq = 1<<5 ,
  fNeedUpdate_children_descr = fNeedUpdate_descr <<kNeedUpdate_bits , fNeedUpdate_children_annot = fNeedUpdate_annot <<kNeedUpdate_bits , fNeedUpdate_children_seq_data = fNeedUpdate_seq_data<<kNeedUpdate_bits , fNeedUpdate_children_core = fNeedUpdate_core <<kNeedUpdate_bits ,
  fNeedUpdate_children_assembly = fNeedUpdate_assembly<<kNeedUpdate_bits , fNeedUpdate_children_bioseq = fNeedUpdate_bioseq <<kNeedUpdate_bits
typedef map< CConstRef< CObject >, CRef< CObject > > TObjectCopyMap
typedef int TNeedUpdateFlags
typedef int TChunkId
typedef vector< TChunkIdTChunkIds
- 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

 CTSE_Info_Object (void)
 CTSE_Info_Object (const CTSE_Info_Object &src, TObjectCopyMap *copy_map)
virtual ~CTSE_Info_Object (void)
virtual const CBioObjectIdGetBioObjectId (void) const
virtual void SetBioObjectId (const CBioObjectId &id)
bool HasDataSource (void) const
CDataSourceGetDataSource (void) const
bool HasTSE_Info (void) const
bool BelongsToTSE_Info (const CTSE_Info &tse) const
const CTSE_InfoGetTSE_Info (void) const
CTSE_InfoGetTSE_Info (void)
bool HasParent_Info (void) const
const CTSE_Info_ObjectGetBaseParent_Info (void) const
CTSE_Info_ObjectGetBaseParent_Info (void)
void x_DSAttach (CDataSource &ds)
void x_DSDetach (CDataSource &ds)
virtual void x_DSAttachContents (CDataSource &ds)
virtual void x_DSDetachContents (CDataSource &ds)
void x_TSEAttach (CTSE_Info &tse)
void x_TSEDetach (CTSE_Info &tse)
virtual void x_TSEAttachContents (CTSE_Info &tse)
virtual void x_TSEDetachContents (CTSE_Info &tse)
bool x_DirtyAnnotIndex (void) const
void x_SetDirtyAnnotIndex (void)
void x_SetParentDirtyAnnotIndex (void)
void x_ResetDirtyAnnotIndex (void)
virtual void x_SetDirtyAnnotIndexNoParent (void)
virtual void x_ResetDirtyAnnotIndexNoParent (void)
void x_UpdateAnnotIndex (CTSE_Info &tse)
virtual void x_UpdateAnnotIndexContents (CTSE_Info &tse)
bool x_NeedUpdate (ENeedUpdate flag) const
void x_SetNeedUpdate (TNeedUpdateFlags flags)
virtual void x_SetNeedUpdateParent (TNeedUpdateFlags flags)
void x_Update (TNeedUpdateFlags flags) const
virtual void x_DoUpdate (TNeedUpdateFlags flags)
void x_UpdateComplete (void) const
void x_UpdateCore (void) const
void x_LoadChunk (TChunkId chunk_id) const
void x_LoadChunks (const TChunkIds &chunk_ids) const
virtual string GetDescription (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 Member Functions

void x_BaseParentAttach (CTSE_Info_Object &parent)
void x_BaseParentDetach (CTSE_Info_Object &parent)
void x_AttachObject (CTSE_Info_Object &object)
void x_DetachObject (CTSE_Info_Object &object)
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...

Private Member Functions

 CTSE_Info_Object (const CTSE_Info_Object &)
CTSE_Info_Objectoperator= (const CTSE_Info_Object &)

Private Attributes

atomic< boolm_DirtyAnnotIndex
atomic< TNeedUpdateFlagsm_NeedUpdateFlags
CBioObjectId m_UniqueId

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 60 of file tse_info_object.hpp.

Member Typedef Documentation

◆ TChunkId

Definition at line 147 of file tse_info_object.hpp.

◆ TChunkIds

Definition at line 148 of file tse_info_object.hpp.

◆ TNeedUpdateFlags

Definition at line 136 of file tse_info_object.hpp.

◆ TObjectCopyMap

Definition at line 63 of file tse_info_object.hpp.

Member Enumeration Documentation

◆ ENeedUpdate


all fields of this object


all fields of children objects


specific fields of this object


specific fields of children


Definition at line 114 of file tse_info_object.hpp.

◆ ENeedUpdateAux


number of bits for fields

Definition at line 110 of file tse_info_object.hpp.

Constructor & Destructor Documentation

◆ CTSE_Info_Object() [1/3]

CTSE_Info_Object::CTSE_Info_Object ( void  )

Definition at line 43 of file tse_info_object.cpp.

◆ CTSE_Info_Object() [2/3]

CTSE_Info_Object::CTSE_Info_Object ( const CTSE_Info_Object src,
TObjectCopyMap copy_map 

Definition at line 52 of file tse_info_object.cpp.

◆ ~CTSE_Info_Object()

CTSE_Info_Object::~CTSE_Info_Object ( void  )

Definition at line 65 of file tse_info_object.cpp.

◆ CTSE_Info_Object() [3/3]

CTSE_Info_Object::CTSE_Info_Object ( const CTSE_Info_Object )

Member Function Documentation

◆ BelongsToTSE_Info()

bool CTSE_Info_Object::BelongsToTSE_Info ( const CTSE_Info tse) const

Definition at line 192 of file tse_info_object.hpp.

References m_TSE_Info.

Referenced by CTSE_ScopeInfo::AddAnnot(), and CTSE_ScopeInfo::GetBioseqLock().

◆ GetBaseParent_Info() [1/2]

CTSE_Info_Object & CTSE_Info_Object::GetBaseParent_Info ( void  )

Definition at line 103 of file tse_info_object.cpp.

References _ASSERT, and m_Parent_Info.

◆ GetBaseParent_Info() [2/2]

const CTSE_Info_Object & CTSE_Info_Object::GetBaseParent_Info ( void  ) const

◆ GetBioObjectId()

const CBioObjectId & CTSE_Info_Object::GetBioObjectId ( void  ) const

◆ GetDataSource()

CDataSource & CTSE_Info_Object::GetDataSource ( void  ) const

◆ GetDescription()

string CTSE_Info_Object::GetDescription ( void  ) const

Reimplemented in CTSE_Info, and CSeq_annot_Info.

Definition at line 350 of file tse_info_object.cpp.

References GetBaseParent_Info(), GetDescription(), HasParent_Info(), and string.

Referenced by GetDescription().

◆ GetTSE_Info() [1/2]

CTSE_Info & CTSE_Info_Object::GetTSE_Info ( void  )

Definition at line 83 of file tse_info_object.cpp.

References _ASSERT, and m_TSE_Info.

◆ GetTSE_Info() [2/2]

const CTSE_Info & CTSE_Info_Object::GetTSE_Info ( void  ) const

◆ HasDataSource()

bool CTSE_Info_Object::HasDataSource ( void  ) const

◆ HasParent_Info()

bool CTSE_Info_Object::HasParent_Info ( void  ) const

◆ HasTSE_Info()

bool CTSE_Info_Object::HasTSE_Info ( void  ) const

◆ operator=()

CTSE_Info_Object& CTSE_Info_Object::operator= ( const CTSE_Info_Object )

◆ SetBioObjectId()

void CTSE_Info_Object::SetBioObjectId ( const CBioObjectId id)

◆ x_AttachObject()

void CTSE_Info_Object::x_AttachObject ( CTSE_Info_Object object)

◆ x_BaseParentAttach()

void CTSE_Info_Object::x_BaseParentAttach ( CTSE_Info_Object parent)

◆ x_BaseParentDetach()

void CTSE_Info_Object::x_BaseParentDetach ( CTSE_Info_Object parent)

◆ x_DetachObject()

void CTSE_Info_Object::x_DetachObject ( CTSE_Info_Object object)

◆ x_DirtyAnnotIndex()

bool CTSE_Info_Object::x_DirtyAnnotIndex ( void  ) const

◆ x_DoUpdate()

void CTSE_Info_Object::x_DoUpdate ( TNeedUpdateFlags  flags)

◆ x_DSAttach()

void CTSE_Info_Object::x_DSAttach ( CDataSource ds)

◆ x_DSAttachContents()

void CTSE_Info_Object::x_DSAttachContents ( CDataSource ds)

◆ x_DSDetach()

void CTSE_Info_Object::x_DSDetach ( CDataSource ds)

◆ x_DSDetachContents()

void CTSE_Info_Object::x_DSDetachContents ( CDataSource ds)

◆ x_LoadChunk()

void CTSE_Info_Object::x_LoadChunk ( TChunkId  chunk_id) const

◆ x_LoadChunks()

void CTSE_Info_Object::x_LoadChunks ( const TChunkIds chunk_ids) const

◆ x_NeedUpdate()

bool CTSE_Info_Object::x_NeedUpdate ( ENeedUpdate  flag) const

◆ x_ResetDirtyAnnotIndex()

void CTSE_Info_Object::x_ResetDirtyAnnotIndex ( void  )

◆ x_ResetDirtyAnnotIndexNoParent()

void CTSE_Info_Object::x_ResetDirtyAnnotIndexNoParent ( void  )

Reimplemented in CTSE_Info.

Definition at line 264 of file tse_info_object.cpp.

Referenced by x_ResetDirtyAnnotIndex().

◆ x_SetDirtyAnnotIndex()

void CTSE_Info_Object::x_SetDirtyAnnotIndex ( void  )

◆ x_SetDirtyAnnotIndexNoParent()

void CTSE_Info_Object::x_SetDirtyAnnotIndexNoParent ( void  )

Reimplemented in CTSE_Info.

Definition at line 240 of file tse_info_object.cpp.

Referenced by x_SetParentDirtyAnnotIndex().

◆ x_SetNeedUpdate()

void CTSE_Info_Object::x_SetNeedUpdate ( TNeedUpdateFlags  flags)

◆ x_SetNeedUpdateParent()

void CTSE_Info_Object::x_SetNeedUpdateParent ( TNeedUpdateFlags  flags)

◆ x_SetParentDirtyAnnotIndex()

void CTSE_Info_Object::x_SetParentDirtyAnnotIndex ( void  )

◆ x_TSEAttach()

void CTSE_Info_Object::x_TSEAttach ( CTSE_Info tse)

◆ x_TSEAttachContents()

void CTSE_Info_Object::x_TSEAttachContents ( CTSE_Info tse)

◆ x_TSEDetach()

void CTSE_Info_Object::x_TSEDetach ( CTSE_Info tse)

◆ x_TSEDetachContents()

void CTSE_Info_Object::x_TSEDetachContents ( CTSE_Info tse)

◆ x_Update()

void CTSE_Info_Object::x_Update ( TNeedUpdateFlags  flags) const

◆ x_UpdateAnnotIndex()

void CTSE_Info_Object::x_UpdateAnnotIndex ( CTSE_Info tse)

◆ x_UpdateAnnotIndexContents()

void CTSE_Info_Object::x_UpdateAnnotIndexContents ( CTSE_Info tse)

◆ x_UpdateComplete()

void CTSE_Info_Object::x_UpdateComplete ( void  ) const

◆ x_UpdateCore()

void CTSE_Info_Object::x_UpdateCore ( void  ) const

Member Data Documentation

◆ m_DirtyAnnotIndex

atomic<bool> CTSE_Info_Object::m_DirtyAnnotIndex

◆ m_NeedUpdateFlags

atomic<TNeedUpdateFlags> CTSE_Info_Object::m_NeedUpdateFlags

◆ m_Parent_Info

CTSE_Info_Object* CTSE_Info_Object::m_Parent_Info

◆ m_TSE_Info

CTSE_Info* CTSE_Info_Object::m_TSE_Info

◆ m_UniqueId

CBioObjectId CTSE_Info_Object::m_UniqueId

Definition at line 171 of file tse_info_object.hpp.

Referenced by GetBioObjectId(), and SetBioObjectId().

The documentation for this class was generated from the following files:
Modified on Thu May 30 12:21:14 2024 by rev. 669887