NCBI C++ ToolKit
Static Public Member Functions | List of all members
CBlastSeqidlistFile Class Reference

Search Toolkit Book for CBlastSeqidlistFile

#include <objtools/blast/seqdb_reader/seqidlist_reader.hpp>

Static Public Member Functions

static int GetSeqidlist (CMemoryFile &file, vector< CSeqDBGiList::SSiOid > &idlist, SBlastSeqIdListInfo &list_info)
 Get seqidlist from dbv5 seqidlist file. More...
 
static int GetSeqidlistInfo (const string &filename, SBlastSeqIdListInfo &list_info)
 Get seqidlist info only from dbv5 seqidlist file. More...
 
static void PrintSeqidlistInfo (const string &filename, CNcbiOstream &os)
 

Detailed Description

Definition at line 45 of file seqidlist_reader.hpp.

Member Function Documentation

◆ GetSeqidlist()

int CBlastSeqidlistFile::GetSeqidlist ( CMemoryFile file,
vector< CSeqDBGiList::SSiOid > &  idlist,
SBlastSeqIdListInfo list_info 
)
static

Get seqidlist from dbv5 seqidlist file.

Parameters
fileseqidlist file
idlistlist of ids read from file
list_infoinfo about seqidlist
Returns
num of ids in the file, return 0 if list is in v4 format (plain text)

Definition at line 111 of file seqidlist_reader.cpp.

References file, CSeqidlistRead::GetIds(), CSeqidlistRead::GetListInfo(), and SBlastSeqIdListInfo::num_ids.

Referenced by BOOST_AUTO_TEST_CASE(), and SeqDB_ReadSiList().

◆ GetSeqidlistInfo()

int CBlastSeqidlistFile::GetSeqidlistInfo ( const string filename,
SBlastSeqIdListInfo list_info 
)
static

Get seqidlist info only from dbv5 seqidlist file.

Parameters
fileseqidlist filename (excpetion if file path cannot be resolved)
list_infoinfo about seqidlist
Returns
num of ids in the file, return 0 if list is in v4 format (plain text)

Definition at line 122 of file seqidlist_reader.cpp.

References file, CSeqidlistRead::GetListInfo(), in(), SBlastSeqIdListInfo::num_ids, and SeqDB_ResolveDbPath().

Referenced by PrintSeqidlistInfo().

◆ PrintSeqidlistInfo()

void CBlastSeqidlistFile::PrintSeqidlistInfo ( const string filename,
CNcbiOstream os 
)
static

The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:04:13 2024 by modify_doxy.py rev. 669887