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

Search Toolkit Book for CPrefetchSeqData

+ Inheritance diagram for CPrefetchSeqData:
+ Collaboration diagram for CPrefetchSeqData:

Public Types

typedef string TResult
 
- Public Types inherited from CPrefetchBioseq
typedef CBioseq_Handle TResult
 
- 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 Types inherited from SPrefetchTypes
enum  EState {
  eInvalid , eQueued , eStarted , eAdvanced ,
  eCompleted , eCanceled , eFailed
}
 
typedef EState EEvent
 
typedef int TPriority
 
typedef int TProgress
 

Public Member Functions

 CPrefetchSeqData (const CBioseq_Handle &bioseq, const CRange< TSeqPos > &range, ENa_strand strand, CSeq_data::E_Choice encoding)
 
 CPrefetchSeqData (const CBioseq_Handle &bioseq, const CRange< TSeqPos > &range, ENa_strand strand, CBioseq_Handle::EVectorCoding vector_coding)
 
virtual bool Execute (CRef< CPrefetchRequest > token)
 
const stringGetSequence (void) const
 
const stringGetResult (void) const
 
- Public Member Functions inherited from CPrefetchBioseq
 CPrefetchBioseq (const CScopeSource &scope, const CSeq_id_Handle &id)
 
const CSeq_id_HandleGetSeq_id (void) const
 
const CBioseq_HandleGetBioseqHandle (void) const
 
const CBioseq_HandleGetResult (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
 
- Public Member Functions inherited from IPrefetchAction
virtual ~IPrefetchAction (void)
 
- Public Member Functions inherited from CScopeSource
 CScopeSource (void)
 
 CScopeSource (CScope &scope)
 
CScopeGetScope (void)
 

Private Attributes

CRange< TSeqPosm_Range
 
ENa_strand m_Strand
 
CSeq_data::E_Choice m_Encoding
 
CBioseq_Handle::EVectorCoding m_VectorCoding
 
TResult m_Result
 

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 Member Functions inherited from CScopeSource
static CScopeSource New (CScope &scope)
 
- 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 CPrefetchBioseq
 CPrefetchBioseq (const CScopeSource &scope)
 
 CPrefetchBioseq (const CBioseq_Handle &bioseq)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 516 of file objmgr_demo.cpp.

Member Typedef Documentation

◆ TResult

Definition at line 520 of file objmgr_demo.cpp.

Constructor & Destructor Documentation

◆ CPrefetchSeqData() [1/2]

CPrefetchSeqData::CPrefetchSeqData ( const CBioseq_Handle bioseq,
const CRange< TSeqPos > &  range,
ENa_strand  strand,
CSeq_data::E_Choice  encoding 
)
inline

Definition at line 523 of file objmgr_demo.cpp.

◆ CPrefetchSeqData() [2/2]

CPrefetchSeqData::CPrefetchSeqData ( const CBioseq_Handle bioseq,
const CRange< TSeqPos > &  range,
ENa_strand  strand,
CBioseq_Handle::EVectorCoding  vector_coding 
)
inline

Definition at line 534 of file objmgr_demo.cpp.

Member Function Documentation

◆ Execute()

virtual bool CPrefetchSeqData::Execute ( CRef< CPrefetchRequest token)
inlinevirtual

◆ GetResult()

const string& CPrefetchSeqData::GetResult ( void  ) const
inline

Definition at line 563 of file objmgr_demo.cpp.

References m_Result.

Referenced by CDemoApp::Run().

◆ GetSequence()

const string& CPrefetchSeqData::GetSequence ( void  ) const
inline

Definition at line 559 of file objmgr_demo.cpp.

References m_Result.

Member Data Documentation

◆ m_Encoding

CSeq_data::E_Choice CPrefetchSeqData::m_Encoding
private

Definition at line 573 of file objmgr_demo.cpp.

Referenced by Execute().

◆ m_Range

CRange<TSeqPos> CPrefetchSeqData::m_Range
private

Definition at line 570 of file objmgr_demo.cpp.

Referenced by Execute().

◆ m_Result

TResult CPrefetchSeqData::m_Result
private

Definition at line 576 of file objmgr_demo.cpp.

Referenced by Execute(), GetResult(), and GetSequence().

◆ m_Strand

ENa_strand CPrefetchSeqData::m_Strand
private

Definition at line 571 of file objmgr_demo.cpp.

Referenced by Execute().

◆ m_VectorCoding

CBioseq_Handle::EVectorCoding CPrefetchSeqData::m_VectorCoding
private

Definition at line 574 of file objmgr_demo.cpp.

Referenced by Execute().


The documentation for this class was generated from the following file:
Modified on Sun Apr 14 05:26:50 2024 by modify_doxy.py rev. 669887