NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CSeq_annot_SplitInfo Class Reference

Search Toolkit Book for CSeq_annot_SplitInfo

#include <objmgr/split/object_splitinfo.hpp>

+ Inheritance diagram for CSeq_annot_SplitInfo:
+ Collaboration diagram for CSeq_annot_SplitInfo:

Public Types

typedef vector< CRef< CLocObjects_SplitInfo > > TObjects
 
- 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

 CSeq_annot_SplitInfo (void)
 
void SetSeq_annot (const CSeq_annot &annot, const SSplitterParams &params, const CBlobSplitterImpl &impl)
 
void Add (const CAnnotObject_SplitInfo &obj)
 
CNcbiOstreamPrint (CNcbiOstream &out) const
 
TAnnotPriority GetPriority (void) const
 
TAnnotPriority GetPriority (const CAnnotObject_SplitInfo &obj) const
 
int Compare (const CSeq_annot_SplitInfo &other) 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
 

Static Public Member Functions

static CAnnotName GetName (const CSeq_annot &annot)
 
static size_t CountAnnotObjects (const CSeq_annot &annot)
 
- 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)
 

Public Attributes

CConstRef< CSeq_annotm_Src_annot
 
CAnnotName m_Name
 
TAnnotPriority m_TopPriority
 
TAnnotPriority m_NamePriority
 
TObjects m_Objects
 
CSize m_Size
 
CSeqsRange m_Location
 

Additional Inherited Members

- 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 178 of file object_splitinfo.hpp.

Member Typedef Documentation

◆ TObjects

Definition at line 181 of file object_splitinfo.hpp.

Constructor & Destructor Documentation

◆ CSeq_annot_SplitInfo()

CSeq_annot_SplitInfo::CSeq_annot_SplitInfo ( void  )

Definition at line 110 of file object_splitinfo.cpp.

Member Function Documentation

◆ Add()

void CSeq_annot_SplitInfo::Add ( const CAnnotObject_SplitInfo obj)

◆ Compare()

int CSeq_annot_SplitInfo::Compare ( const CSeq_annot_SplitInfo other) const

◆ CountAnnotObjects()

size_t CSeq_annot_SplitInfo::CountAnnotObjects ( const CSeq_annot annot)
static

◆ GetName()

CAnnotName CSeq_annot_SplitInfo::GetName ( const CSeq_annot annot)
static

◆ GetPriority() [1/2]

TAnnotPriority CSeq_annot_SplitInfo::GetPriority ( const CAnnotObject_SplitInfo obj) const

◆ GetPriority() [2/2]

TAnnotPriority CSeq_annot_SplitInfo::GetPriority ( void  ) const

◆ Print()

CNcbiOstream & CSeq_annot_SplitInfo::Print ( CNcbiOstream out) const

◆ SetSeq_annot()

void CSeq_annot_SplitInfo::SetSeq_annot ( const CSeq_annot annot,
const SSplitterParams params,
const CBlobSplitterImpl impl 
)

Member Data Documentation

◆ m_Location

CSeqsRange CSeq_annot_SplitInfo::m_Location

Definition at line 208 of file object_splitinfo.hpp.

Referenced by Add(), and Compare().

◆ m_Name

CAnnotName CSeq_annot_SplitInfo::m_Name

Definition at line 201 of file object_splitinfo.hpp.

Referenced by Print(), and SetSeq_annot().

◆ m_NamePriority

TAnnotPriority CSeq_annot_SplitInfo::m_NamePriority

Definition at line 204 of file object_splitinfo.hpp.

Referenced by GetPriority(), and SetSeq_annot().

◆ m_Objects

TObjects CSeq_annot_SplitInfo::m_Objects

Definition at line 205 of file object_splitinfo.hpp.

Referenced by Add(), and Print().

◆ m_Size

CSize CSeq_annot_SplitInfo::m_Size

Definition at line 207 of file object_splitinfo.hpp.

Referenced by Compare(), Print(), and SetSeq_annot().

◆ m_Src_annot

CConstRef<CSeq_annot> CSeq_annot_SplitInfo::m_Src_annot

◆ m_TopPriority

TAnnotPriority CSeq_annot_SplitInfo::m_TopPriority

Definition at line 203 of file object_splitinfo.hpp.

Referenced by Add(), GetPriority(), and SetSeq_annot().


The documentation for this class was generated from the following files:
Modified on Wed May 22 11:29:34 2024 by modify_doxy.py rev. 669887