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

Search Toolkit Book for CWGSFeatureIterator

#include <sra/readers/sra/wgsread.hpp>

+ Collaboration diagram for CWGSFeatureIterator:

Public Member Functions

 CWGSFeatureIterator (void)
 
 CWGSFeatureIterator (const CWGSDb &wgs)
 
 CWGSFeatureIterator (const CWGSDb &wgs, TVDBRowId row)
 
 CWGSFeatureIterator (const CWGSDb &wgs, TVDBRowIdRange row_range)
 
 ~CWGSFeatureIterator (void)
 
void Reset (void)
 
 CWGSFeatureIterator (const CWGSFeatureIterator &iter)
 
CWGSFeatureIteratoroperator= (const CWGSFeatureIterator &iter)
 
 DECLARE_OPERATOR_BOOL (m_CurrId< m_FirstBadId)
 
CWGSFeatureIteratoroperator++ (void)
 
TVDBRowId GetCurrentRowId (void) const
 
TVDBRowId GetFirstGoodRowId (void) const
 
TVDBRowId GetFirstBadRowId (void) const
 
TVDBRowCount GetRemainingCount (void) const
 
TVDBRowCount GetSize (void) const
 
CWGSFeatureIteratorSelectRow (TVDBRowId row)
 
CWGSFeatureIteratorSelectRowRange (TVDBRowIdRange row_range)
 
NCBI_WGS_feattype GetFeatType (void) const
 
NCBI_WGS_seqtype GetLocSeqType (void) const
 
NCBI_WGS_seqtype GetProductSeqType (void) const
 
TVDBRowId GetLocRowId (void) const
 
TVDBRowId GetProductRowId (void) const
 
TSeqPos GetLocStart (void) const
 
TSeqPos GetLocLength (void) const
 
CRange< TSeqPosGetLocRange (void) const
 
CTempString GetSeq_featBytes (void) const
 
CRef< CSeq_featGetSeq_feat () const
 

Protected Member Functions

CWGSDb_ImplGetDb (void) const
 
void x_Init (const CWGSDb &wgs_db)
 
void x_ReportInvalid (const char *method) const
 
void x_CheckValid (const char *method) const
 

Private Attributes

CWGSDb m_Db
 
CRef< CWGSDb_Impl::SFeatTableCursorm_Cur
 
TVDBRowId m_CurrId
 
TVDBRowId m_FirstGoodId
 
TVDBRowId m_FirstBadId
 

Detailed Description

Definition at line 1526 of file wgsread.hpp.

Constructor & Destructor Documentation

◆ CWGSFeatureIterator() [1/5]

CWGSFeatureIterator::CWGSFeatureIterator ( void  )

Definition at line 7658 of file wgsread.cpp.

◆ CWGSFeatureIterator() [2/5]

CWGSFeatureIterator::CWGSFeatureIterator ( const CWGSDb wgs)
explicit

Definition at line 7690 of file wgsread.cpp.

References x_Init().

◆ CWGSFeatureIterator() [3/5]

CWGSFeatureIterator::CWGSFeatureIterator ( const CWGSDb wgs,
TVDBRowId  row 
)

Definition at line 7696 of file wgsread.cpp.

References SelectRow(), and x_Init().

◆ CWGSFeatureIterator() [4/5]

CWGSFeatureIterator::CWGSFeatureIterator ( const CWGSDb wgs,
TVDBRowIdRange  row_range 
)

Definition at line 7703 of file wgsread.cpp.

References m_CurrId, m_Db, m_FirstBadId, m_FirstGoodId, max(), min(), and x_Init().

◆ ~CWGSFeatureIterator()

CWGSFeatureIterator::~CWGSFeatureIterator ( void  )

Definition at line 7715 of file wgsread.cpp.

References Reset().

◆ CWGSFeatureIterator() [5/5]

CWGSFeatureIterator::CWGSFeatureIterator ( const CWGSFeatureIterator iter)

Definition at line 7666 of file wgsread.cpp.

Member Function Documentation

◆ DECLARE_OPERATOR_BOOL()

CWGSFeatureIterator::DECLARE_OPERATOR_BOOL ( )

◆ GetCurrentRowId()

TVDBRowId CWGSFeatureIterator::GetCurrentRowId ( void  ) const
inline

Definition at line 1547 of file wgsread.hpp.

References m_CurrId.

Referenced by GetRemainingCount().

◆ GetDb()

CWGSDb_Impl& CWGSFeatureIterator::GetDb ( void  ) const
inlineprotected

Definition at line 1582 of file wgsread.hpp.

References CRef< C, Locker >::GetNCObject(), and m_Db.

Referenced by Reset().

◆ GetFeatType()

NCBI_WGS_feattype CWGSFeatureIterator::GetFeatType ( void  ) const

Definition at line 7803 of file wgsread.cpp.

References m_Cur, m_CurrId, and x_CheckValid().

◆ GetFirstBadRowId()

TVDBRowId CWGSFeatureIterator::GetFirstBadRowId ( void  ) const
inline

Definition at line 1553 of file wgsread.hpp.

References m_FirstBadId.

Referenced by GetRemainingCount(), and GetSize().

◆ GetFirstGoodRowId()

TVDBRowId CWGSFeatureIterator::GetFirstGoodRowId ( void  ) const
inline

Definition at line 1550 of file wgsread.hpp.

References m_FirstGoodId.

Referenced by GetSize().

◆ GetLocLength()

TSeqPos CWGSFeatureIterator::GetLocLength ( void  ) const

Definition at line 7817 of file wgsread.cpp.

References m_Cur, m_CurrId, and x_CheckValid().

◆ GetLocRange()

CRange< TSeqPos > CWGSFeatureIterator::GetLocRange ( void  ) const

Definition at line 7824 of file wgsread.cpp.

References m_Cur, m_CurrId, compile_time_bits::range(), and x_CheckValid().

◆ GetLocRowId()

TVDBRowId CWGSFeatureIterator::GetLocRowId ( void  ) const

Definition at line 7785 of file wgsread.cpp.

References m_Cur, m_CurrId, and x_CheckValid().

Referenced by CWGSFileInfo::SAccFileInfo::GetRootFileInfo(), and CWGSClient::GetRootSeq().

◆ GetLocSeqType()

NCBI_WGS_seqtype CWGSFeatureIterator::GetLocSeqType ( void  ) const

Definition at line 7771 of file wgsread.cpp.

References m_Cur, m_CurrId, and x_CheckValid().

Referenced by CWGSFileInfo::SAccFileInfo::GetRootFileInfo(), and CWGSClient::GetRootSeq().

◆ GetLocStart()

TSeqPos CWGSFeatureIterator::GetLocStart ( void  ) const

Definition at line 7810 of file wgsread.cpp.

References m_Cur, m_CurrId, and x_CheckValid().

◆ GetProductRowId()

TVDBRowId CWGSFeatureIterator::GetProductRowId ( void  ) const

Definition at line 7792 of file wgsread.cpp.

References CVDBValue::empty(), m_Cur, m_CurrId, and x_CheckValid().

◆ GetProductSeqType()

NCBI_WGS_seqtype CWGSFeatureIterator::GetProductSeqType ( void  ) const

Definition at line 7778 of file wgsread.cpp.

References m_Cur, m_CurrId, and x_CheckValid().

◆ GetRemainingCount()

TVDBRowCount CWGSFeatureIterator::GetRemainingCount ( void  ) const
inline

Definition at line 1556 of file wgsread.hpp.

References GetCurrentRowId(), and GetFirstBadRowId().

◆ GetSeq_feat()

CRef< CSeq_feat > CWGSFeatureIterator::GetSeq_feat ( void  ) const

◆ GetSeq_featBytes()

CTempString CWGSFeatureIterator::GetSeq_featBytes ( void  ) const

Definition at line 7834 of file wgsread.cpp.

References m_Cur, m_CurrId, and PROFILE.

Referenced by GetSeq_feat(), and SWGSCreateInfo::x_AddFeature().

◆ GetSize()

TVDBRowCount CWGSFeatureIterator::GetSize ( void  ) const
inline

Definition at line 1559 of file wgsread.hpp.

References GetFirstBadRowId(), and GetFirstGoodRowId().

◆ operator++()

CWGSFeatureIterator& CWGSFeatureIterator::operator++ ( void  )
inline

Definition at line 1542 of file wgsread.hpp.

References m_CurrId.

◆ operator=()

CWGSFeatureIterator & CWGSFeatureIterator::operator= ( const CWGSFeatureIterator iter)

Definition at line 7676 of file wgsread.cpp.

References m_Cur, m_CurrId, m_Db, m_FirstBadId, m_FirstGoodId, and Reset().

◆ Reset()

void CWGSFeatureIterator::Reset ( void  )

◆ SelectRow()

CWGSFeatureIterator & CWGSFeatureIterator::SelectRow ( TVDBRowId  row)

Definition at line 7722 of file wgsread.cpp.

References m_CurrId, m_FirstBadId, and m_FirstGoodId.

Referenced by CWGSFeatureIterator().

◆ SelectRowRange()

CWGSFeatureIterator & CWGSFeatureIterator::SelectRowRange ( TVDBRowIdRange  row_range)

◆ x_CheckValid()

void CWGSFeatureIterator::x_CheckValid ( const char *  method) const
inlineprotected

◆ x_Init()

void CWGSFeatureIterator::x_Init ( const CWGSDb wgs_db)
protected

◆ x_ReportInvalid()

void CWGSFeatureIterator::x_ReportInvalid ( const char *  method) const
protected

Definition at line 7763 of file wgsread.cpp.

References NCBI_THROW_FMT.

Referenced by x_CheckValid().

Member Data Documentation

◆ m_Cur

CRef<CWGSDb_Impl::SFeatTableCursor> CWGSFeatureIterator::m_Cur
private

◆ m_CurrId

TVDBRowId CWGSFeatureIterator::m_CurrId
private

◆ m_Db

CWGSDb CWGSFeatureIterator::m_Db
private

Definition at line 1596 of file wgsread.hpp.

Referenced by CWGSFeatureIterator(), GetDb(), operator=(), Reset(), and x_Init().

◆ m_FirstBadId

TVDBRowId CWGSFeatureIterator::m_FirstBadId
private

◆ m_FirstGoodId

TVDBRowId CWGSFeatureIterator::m_FirstGoodId
private

The documentation for this class was generated from the following files:
Modified on Tue Feb 27 05:53:28 2024 by modify_doxy.py rev. 669887