CBGZFPos Class Reference

Search Toolkit Book for CBGZFPos

#include <sra/readers/bam/bgzf.hpp>

Public Types
typedef Uint8	TFileBlockPos
typedef Uint4	TByteOffset
typedef Uint8	TVirtualPos

Public Member Functions
	CBGZFPos ()
	CBGZFPos (TVirtualPos pos)
	CBGZFPos (TFileBlockPos block_pos, TByteOffset byte_offset)
TVirtualPos	GetVirtualPos () const
TFileBlockPos	GetFileBlockPos () const
TByteOffset	GetByteOffset () const
bool	operator== (const CBGZFPos &b) const
bool	operator!= (const CBGZFPos &b) const
bool	operator< (const CBGZFPos &b) const
bool	operator> (const CBGZFPos &b) const
bool	operator<= (const CBGZFPos &b) const
bool	operator>= (const CBGZFPos &b) const
bool	IsInvalid () const
	DECLARE_OPERATOR_BOOL (m_VirtualPos !=0)

Static Public Member Functions
static CBGZFPos	GetInvalid ()

Static Public Attributes
static const Uint4	kMaxBlockSize = 1<<16

Private Attributes
TVirtualPos	m_VirtualPos

Detailed Description

Definition at line 192 of file bgzf.hpp.

Member Typedef Documentation

TByteOffset

typedef Uint4 CBGZFPos::TByteOffset

Definition at line 196 of file bgzf.hpp.

TFileBlockPos

typedef Uint8 CBGZFPos::TFileBlockPos

Definition at line 195 of file bgzf.hpp.

TVirtualPos

typedef Uint8 CBGZFPos::TVirtualPos

Definition at line 197 of file bgzf.hpp.

Constructor & Destructor Documentation

CBGZFPos() [1/3]

CBGZFPos::CBGZFPos ( )

inline

Definition at line 201 of file bgzf.hpp.

Referenced by GetInvalid().

CBGZFPos() [2/3]

CBGZFPos::CBGZFPos ( TVirtualPos  pos )

inlineexplicit

Definition at line 206 of file bgzf.hpp.

CBGZFPos() [3/3]

CBGZFPos::CBGZFPos ( TFileBlockPos  block_pos, TByteOffset  byte_offset  )

inline

Definition at line 210 of file bgzf.hpp.

Member Function Documentation

DECLARE_OPERATOR_BOOL()

CBGZFPos::DECLARE_OPERATOR_BOOL

(

m_VirtualPos !

= 0

)

GetByteOffset()

TByteOffset CBGZFPos::GetByteOffset ( ) const

inline

Definition at line 224 of file bgzf.hpp.

References m_VirtualPos.

Referenced by operator<<(), s_EstimatedPos(), and CBGZFStream::Seek().

GetFileBlockPos()

TFileBlockPos CBGZFPos::GetFileBlockPos ( ) const

inline

Definition at line 220 of file bgzf.hpp.

References m_VirtualPos.

Referenced by operator<<(), s_EstimatedPos(), and CBGZFStream::Seek().

GetInvalid()

static CBGZFPos CBGZFPos::GetInvalid ( )

inlinestatic

Definition at line 254 of file bgzf.hpp.

References CBGZFPos().

Referenced by CBamFileRangeSet::AddFrom(), CBamFileRangeSet::AddRanges(), SBamIndexRefIndex::GetAlnOverStarts(), SBamIndexRefIndex::GetFileRange(), SBamIndexRefIndex::GetLimitRange(), CBGZFStream::Open(), s_GetFilePos(), s_GetNextFilePos(), and s_GetOverlap().

GetVirtualPos()

TVirtualPos CBGZFPos::GetVirtualPos ( ) const

inline

Definition at line 215 of file bgzf.hpp.

References m_VirtualPos.

Referenced by IsInvalid().

IsInvalid()

bool CBGZFPos::IsInvalid ( void  ) const

inline

Definition at line 258 of file bgzf.hpp.

References GetVirtualPos().

Referenced by SBamIndexRefIndex::GetAlnOverStarts().

operator!=()

bool CBGZFPos::operator!= ( const CBGZFPos &  b ) const

inline

Definition at line 233 of file bgzf.hpp.

References b, and m_VirtualPos.

operator<()

bool CBGZFPos::operator< ( const CBGZFPos &  b ) const

inline

Definition at line 237 of file bgzf.hpp.

References b, and m_VirtualPos.

operator<=()

bool CBGZFPos::operator<= ( const CBGZFPos &  b ) const

inline

Definition at line 245 of file bgzf.hpp.

References b, and m_VirtualPos.

operator==()

bool CBGZFPos::operator== ( const CBGZFPos &  b ) const

inline

Definition at line 229 of file bgzf.hpp.

References b, and m_VirtualPos.

operator>()

bool CBGZFPos::operator> ( const CBGZFPos &  b ) const

inline

Definition at line 241 of file bgzf.hpp.

References b, and m_VirtualPos.

operator>=()

bool CBGZFPos::operator>= ( const CBGZFPos &  b ) const

inline

Definition at line 249 of file bgzf.hpp.

References b, and m_VirtualPos.

Member Data Documentation

kMaxBlockSize

const Uint4 CBGZFPos::kMaxBlockSize = 1<<16

static

Definition at line 199 of file bgzf.hpp.

m_VirtualPos

TVirtualPos CBGZFPos::m_VirtualPos

private

Definition at line 266 of file bgzf.hpp.

Referenced by GetByteOffset(), GetFileBlockPos(), GetVirtualPos(), operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

---

The documentation for this class was generated from the following file:

• include/sra/readers/bam/bgzf.hpp