CVDBTable Class Reference

Search Toolkit Book for CVDBTable

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

Inheritance diagram for CVDBTable:

Collaboration diagram for CVDBTable:

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

Public Member Functions
	CVDBTable (void)
	CVDBTable (const CVDB &db, const char *table_name, EMissing missing=eMissing_Throw)
	CVDBTable (const CVDBMgr &mgr, const string &acc_or_path, EMissing missing=eMissing_Throw)
const CVDB &	GetDb (void) const
const string &	GetName (void) const
string	GetFullName (void) const
CNcbiOstream &	PrintFullName (CNcbiOstream &out) const
void	Close (void)
Public Member Functions inherited from CSraRef< const VTable >
	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

Public Attributes
CVDB	m_Db
string	m_Name

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

Detailed Description

Definition at line 293 of file vdbread.hpp.

Member Enumeration Documentation

EMissing

enum CVDBTable::EMissing

Enumerator
eMissing_Throw
eMissing_Allow

Definition at line 297 of file vdbread.hpp.

Constructor & Destructor Documentation

CVDBTable() [1/3]

CVDBTable::CVDBTable ( void  )

inline

Definition at line 302 of file vdbread.hpp.

Referenced by Close().

CVDBTable() [2/3]

CVDBTable::CVDBTable	(	const CVDB &	db,
		const char *	table_name,
		EMissing	missing = eMissing_Throw
	)

Definition at line 1137 of file vdbread.cpp.

References CHECK_VDB_TIMEOUT, DECLARE_SDK_GUARD, eMissing_Throw, GetFullName(), NCBI_THROW2, SIMULATE_SCHEMA_ERROR, table_name, and CSraRef< const VTable >::x_InitPtr().

CVDBTable() [3/3]

CVDBTable::CVDBTable	(	const CVDBMgr &	mgr,
		const string &	acc_or_path,
		EMissing	missing = eMissing_Throw
	)

Definition at line 1169 of file vdbread.cpp.

References CHECK_VDB_TIMEOUT, CVPath::ConvertAccOrSysPathToPOSIX(), DECLARE_SDK_GUARD, eMissing_Throw, NCBI_THROW2, SIMULATE_OPEN_ERROR, and CSraRef< const VTable >::x_InitPtr().

Member Function Documentation

Close()

void CVDBTable::Close ( void  )

inline

Definition at line 323 of file vdbread.hpp.

References CVDBTable().

GetDb()

const CVDB& CVDBTable::GetDb ( void  ) const

inline

Definition at line 312 of file vdbread.hpp.

References m_Db.

Referenced by GetFullName(), and PrintFullName().

GetFullName()

string CVDBTable::GetFullName

(

void

)

const

Definition at line 1206 of file vdbread.cpp.

References GetDb(), CVDB::GetFullName(), and GetName().

Referenced by CVDBTable(), and CVDBTableIndex::GetFullName().

GetName()

const string& CVDBTable::GetName ( void  ) const

inline

Definition at line 316 of file vdbread.hpp.

References m_Name.

Referenced by GetFullName(), and PrintFullName().

PrintFullName()

CNcbiOstream & CVDBTable::PrintFullName

(

CNcbiOstream &

out

)

const

Definition at line 1218 of file vdbread.cpp.

References GetDb(), GetName(), out(), and CVDB::PrintFullName().

Referenced by operator<<(), CVDBTableIndex::PrintFullName(), and CVDBValue::SSaveRef::PrintFullName().

Member Data Documentation

m_Db

CVDB CVDBTable::m_Db

Definition at line 328 of file vdbread.hpp.

Referenced by GetDb().

m_Name

string CVDBTable::m_Name

Definition at line 329 of file vdbread.hpp.

Referenced by GetName().

---

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

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