NCBI C++ ToolKit
Public Types | Public Member Functions | List of all members
CBioseq_set_ScopeInfo Class Reference

Search Toolkit Book for CBioseq_set_ScopeInfo

#include <objmgr/bioseq_set_handle.hpp>

+ Inheritance diagram for CBioseq_set_ScopeInfo:
+ Collaboration diagram for CBioseq_set_ScopeInfo:

Public Types

typedef CBioseq_set_Info TObjectInfo
 
- Public Types inherited from CScopeInfo_Base
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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CBioseq_set_ScopeInfo (const CTSE_Handle &tse, const TObjectInfo &info)
 
const TObjectInfoGetObjectInfo (void) const
 
TObjectInfoGetNCObjectInfo (void)
 
- Public Member Functions inherited from CScopeInfo_Base
 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
 
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
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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 Types inherited from CScopeInfo_Base
enum  ECheckFlags {
  fAllowZero = 0x00, fForceZero = 0x01, fForbidZero = 0x02, fAllowInfo = 0x00,
  fForceInfo = 0x10, fForbidInfo = 0x20
}
 
typedef int TCheckFlags
 
- Protected Member Functions inherited from CScopeInfo_Base
virtual void x_SetLock (const CTSE_ScopeUserLock &tse, const CTSE_Info_Object &info)
 
virtual void x_ResetLock (void)
 
virtual void x_AttachTSE (CTSE_ScopeInfo *tse)
 
virtual void x_DetachTSE (CTSE_ScopeInfo *tse)
 
virtual void x_ForgetTSE (CTSE_ScopeInfo *tse)
 
bool x_Check (TCheckFlags zero_counter_mode) const
 
void x_RemoveLastInfoLock (void)
 
void AddInfoLock (void)
 
void RemoveInfoLock (void)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 77 of file bioseq_set_handle.hpp.

Member Typedef Documentation

Definition at line 80 of file bioseq_set_handle.hpp.

Constructor & Destructor Documentation

CBioseq_set_ScopeInfo::CBioseq_set_ScopeInfo ( const CTSE_Handle tse,
const TObjectInfo info 
)
inline

Definition at line 82 of file bioseq_set_handle.hpp.

Member Function Documentation

TObjectInfo& CBioseq_set_ScopeInfo::GetNCObjectInfo ( void  )
inline

Definition at line 91 of file bioseq_set_handle.hpp.

Referenced by CTSE_ScopeInfo::AddEntry(), and CTSE_ScopeInfo::SelectSet().

const TObjectInfo& CBioseq_set_ScopeInfo::GetObjectInfo ( void  ) const
inline

Definition at line 87 of file bioseq_set_handle.hpp.

Referenced by CBioseq_set_Handle::x_GetInfo().


The documentation for this class was generated from the following file:
Modified on Sat May 27 15:28:16 2017 by modify_doxy.py rev. 533848