CVDBTableIndex Class Reference

Search Toolkit Book for CVDBTableIndex

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

Inheritance diagram for CVDBTableIndex:

Collaboration diagram for CVDBTableIndex:

Public Types
enum	EMissing { eMissing_Throw , eMissing_Allow }
Public Types inherited from CSraRef< const KIndex >
typedef const KIndex	TObject
typedef TObject *	TPointer

Public Member Functions
	CVDBTableIndex (void)
	CVDBTableIndex (const CVDBTable &table, const char *index_name, EMissing missing=eMissing_Throw)
const CVDBTable &	GetTable (void) const
const char *	GetName (void) const
string	GetFullName (void) const
CNcbiOstream &	PrintFullName (CNcbiOstream &out) const
TVDBRowIdRange	Find (const string &value) const
void	Close (void)
Public Member Functions inherited from CSraRef< const KIndex >
	CSraRef (void)
	CSraRef (const TSelf &ref)
	CSraRef (TSelf &&ref)
	Copy constructor from an existing CRef object,. More...
TSelf &	operator= (const TSelf &ref)
TSelf &	operator= (TSelf &&ref)
	~CSraRef (void)
void	Release (void)
TObject *	GetPointer (void) const
	operator TObject * (void) const
TObject *	operator-> (void) const
TObject &	operator* (void) const

Private Attributes
CVDBTable	m_Table
const char *	m_Name

Additional Inherited Members
Protected Types inherited from CSraRef< const KIndex >
typedef CSraRef< const KIndex >	TSelf
typedef CSraRefTraits< const KIndex >	TTraits
Protected Member Functions inherited from CSraRef< const KIndex >
	CSraRef (TPointer ptr)
TObject **	x_InitPtr (void)
Static Protected Member Functions inherited from CSraRef< const KIndex >
static TObject *	s_AddRef (const TSelf &ref)

Detailed Description

Definition at line 333 of file vdbread.hpp.

Member Enumeration Documentation

EMissing

enum CVDBTableIndex::EMissing

Enumerator
eMissing_Throw
eMissing_Allow

Definition at line 337 of file vdbread.hpp.

Constructor & Destructor Documentation

CVDBTableIndex() [1/2]

CVDBTableIndex::CVDBTableIndex ( void  )

inline

Definition at line 342 of file vdbread.hpp.

Referenced by Close().

CVDBTableIndex() [2/2]

CVDBTableIndex::CVDBTableIndex	(	const CVDBTable &	table,
		const char *	index_name,
		EMissing	missing = eMissing_Throw
	)

Definition at line 1224 of file vdbread.cpp.

References CHECK_VDB_TIMEOUT, eMissing_Throw, GetFullName(), NCBI_THROW2, SIMULATE_SCHEMA_ERROR, table, and CSraRef< const KIndex >::x_InitPtr().

Member Function Documentation

Close()

void CVDBTableIndex::Close ( void  )

inline

Definition at line 362 of file vdbread.hpp.

References CVDBTableIndex().

Find()

TVDBRowIdRange CVDBTableIndex::Find

(

const string &

value

)

const

Definition at line 1263 of file vdbread.cpp.

References CHECK_VDB_TIMEOUT_FMT, NCBI_THROW2_FMT, compile_time_bits::range(), and value.

Referenced by CVDBGraphDb_Impl::CVDBGraphDb_Impl(), CSNPDb_Impl::FindSeq(), CVDBGraphDb_Impl::GetSeqInfo(), CVDBGraphDb_Impl::GetSeqInfoAtRow(), and CWGSDb_Impl::Lookup().

GetFullName()

string CVDBTableIndex::GetFullName

(

void

)

const

Definition at line 1251 of file vdbread.cpp.

References CVDBTable::GetFullName(), GetName(), and GetTable().

Referenced by CVDBTableIndex().

GetName()

const char* CVDBTableIndex::GetName ( void  ) const

inline

Definition at line 353 of file vdbread.hpp.

References m_Name.

Referenced by GetFullName(), and PrintFullName().

GetTable()

const CVDBTable& CVDBTableIndex::GetTable ( void  ) const

inline

Definition at line 349 of file vdbread.hpp.

References m_Table.

Referenced by GetFullName(), and PrintFullName().

PrintFullName()

CNcbiOstream & CVDBTableIndex::PrintFullName

(

CNcbiOstream &

out

)

const

Definition at line 1257 of file vdbread.cpp.

References GetName(), GetTable(), out(), and CVDBTable::PrintFullName().

Referenced by operator<<().

Member Data Documentation

m_Name

const char* CVDBTableIndex::m_Name

private

Definition at line 368 of file vdbread.hpp.

Referenced by GetName().

m_Table

CVDBTable CVDBTableIndex::m_Table

private

Definition at line 367 of file vdbread.hpp.

Referenced by GetTable().

---

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

• include/sra/readers/sra/vdbread.hpp
• src/sra/readers/sra/vdbread.cpp