CBlastDbMetadata Class Reference

Search Toolkit Book for CBlastDbMetadata

Proxy class for retrieving meta data from a BLAST DB. More...

Collaboration diagram for CBlastDbMetadata:

Public Member Functions
	CBlastDbMetadata (const SSeqDBInitInfo &db_init_info)
string	GetFileName () const
string	GetMoleculeType () const
string	GetTitle ()
string	GetDate ()
string	GetNumberOfSequences ()
string	GetDbLength ()
string	GetDiskUsage ()
string	GetVersion ()

Private Member Functions
void	x_InitBlastDb ()
	Initialize and cache BLAST DB handle if necessary. More...

Private Attributes
SSeqDBInitInfo	m_DbInitInfo
	Information to initialize the BLAST DB handle. More...
CRef< CSeqDB >	m_BlastDb
	BLAST DB handle. More...

Detailed Description

Proxy class for retrieving meta data from a BLAST DB.

Definition at line 68 of file blastdb_formatter.cpp.

Constructor & Destructor Documentation

CBlastDbMetadata()

CBlastDbMetadata::CBlastDbMetadata ( const SSeqDBInitInfo &  db_init_info )

inline

Definition at line 70 of file blastdb_formatter.cpp.

Member Function Documentation

GetDate()

string CBlastDbMetadata::GetDate ( void  )

inline

Definition at line 84 of file blastdb_formatter.cpp.

References CSeqDB::GetDate(), m_BlastDb, and x_InitBlastDb().

Referenced by CBlastDbFormatter::Write().

GetDbLength()

string CBlastDbMetadata::GetDbLength ( void  )

inline

Definition at line 93 of file blastdb_formatter.cpp.

References CSeqDB::GetTotalLength(), m_BlastDb, NStr::UInt8ToString(), and x_InitBlastDb().

Referenced by CBlastDbFormatter::Write().

GetDiskUsage()

string CBlastDbMetadata::GetDiskUsage ( )

inline

Definition at line 98 of file blastdb_formatter.cpp.

References CSeqDB::GetDiskUsage(), m_BlastDb, NStr::UInt8ToString(), and x_InitBlastDb().

Referenced by CBlastDbFormatter::Write().

GetFileName()

string CBlastDbMetadata::GetFileName ( void  ) const

inline

Definition at line 74 of file blastdb_formatter.cpp.

References kEmptyStr, SSeqDBInitInfo::m_BlastDbName, m_DbInitInfo, and NStr::Replace().

Referenced by CBlastDbFormatter::Write().

GetMoleculeType()

string CBlastDbMetadata::GetMoleculeType ( ) const

inline

Definition at line 77 of file blastdb_formatter.cpp.

References CSeqDB::ESeqType2String(), m_DbInitInfo, and SSeqDBInitInfo::m_MoleculeType.

Referenced by CBlastDbFormatter::Write().

GetNumberOfSequences()

string CBlastDbMetadata::GetNumberOfSequences ( )

inline

Definition at line 88 of file blastdb_formatter.cpp.

References CSeqDB::GetNumSeqs(), NStr::IntToString(), m_BlastDb, and x_InitBlastDb().

Referenced by CBlastDbFormatter::Write().

GetTitle()

string CBlastDbMetadata::GetTitle ( void  )

inline

Definition at line 80 of file blastdb_formatter.cpp.

References CSeqDB::GetTitle(), m_BlastDb, and x_InitBlastDb().

Referenced by CBlastDbFormatter::Write().

GetVersion()

string CBlastDbMetadata::GetVersion ( void  )

inline

Definition at line 102 of file blastdb_formatter.cpp.

References eBDB_Version5, CSeqDB::GetBlastDbVersion(), NStr::IntToString(), m_BlastDb, and x_InitBlastDb().

Referenced by CBlastDbFormatter::Write().

x_InitBlastDb()

void CBlastDbMetadata::x_InitBlastDb ( )

inlineprivate

Initialize and cache BLAST DB handle if necessary.

Definition at line 115 of file blastdb_formatter.cpp.

References _ASSERT, CRef< C, Locker >::Empty(), SSeqDBInitInfo::InitSeqDb(), m_BlastDb, m_DbInitInfo, and CRef< C, Locker >::NotEmpty().

Referenced by GetDate(), GetDbLength(), GetDiskUsage(), GetNumberOfSequences(), GetTitle(), and GetVersion().

Member Data Documentation

m_BlastDb

CRef<CSeqDB> CBlastDbMetadata::m_BlastDb

private

BLAST DB handle.

Definition at line 112 of file blastdb_formatter.cpp.

Referenced by GetDate(), GetDbLength(), GetDiskUsage(), GetNumberOfSequences(), GetTitle(), GetVersion(), and x_InitBlastDb().

m_DbInitInfo

SSeqDBInitInfo CBlastDbMetadata::m_DbInitInfo

private

Information to initialize the BLAST DB handle.

Definition at line 110 of file blastdb_formatter.cpp.

Referenced by GetFileName(), GetMoleculeType(), and x_InitBlastDb().

---

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

• src/objtools/blast/blastdb_format/blastdb_formatter.cpp