NCBI C++ ToolKit
Public Attributes | List of all members
BlastSeqSrc Struct Reference

Search Toolkit Book for BlastSeqSrc

Complete type definition of Blast Sequence Source ADT. More...

+ Collaboration diagram for BlastSeqSrc:

Public Attributes

BlastSeqSrcConstructor NewFnPtr
 Constructor. More...
 
BlastSeqSrcDestructor DeleteFnPtr
 Destructor. More...
 
BlastSeqSrcCopier CopyFnPtr
 Copier. More...
 
SetInt4FnPtr SetNumberOfThreads
 Set number of threads. More...
 
GetInt4FnPtr GetNumSeqs
 Get number of sequences in set. More...
 
GetInt4FnPtr GetNumSeqsStats
 Number of sequences for statistical purposes. More...
 
GetInt4FnPtr GetMaxSeqLen
 Get length of longest seq in set. More...
 
GetInt4FnPtr GetMinSeqLen
 Get length of longest seq in set. More...
 
GetInt4FnPtr GetAvgSeqLen
 Get average length of sequences in the set. More...
 
GetInt8FnPtr GetTotLen
 Get tot length of all seqs in set. More...
 
GetInt8FnPtr GetTotLenStats
 Total length of all seqs for statistical purposes. More...
 
GetStrFnPtr GetName
 Get the name of the database. More...
 
GetBoolFnPtr GetIsProt
 Find if database is a protein or nucleotide. More...
 
GetBoolFnPtr GetSupportsPartialFetching
 Find if database supports partial fetching. More...
 
SetSeqRangeFnPtr SetSeqRange
 Setting ranges for partial fetching. More...
 
GetSeqBlkFnPtr GetSequence
 Retrieve individual sequence. More...
 
GetInt4FnPtr GetSeqLen
 Retrieve given sequence length. More...
 
ReleaseSeqBlkFnPtr ReleaseSequence
 Deallocate individual sequence (if applicable) More...
 
AdvanceIteratorFnPtr IterNext
 Gets next oid from the iterator. More...
 
ResetChunkIteratorFnPtr ResetChunkIterator
 Reset the implementation's chunk "bookmark". More...
 
void * DataStructure
 ADT holding the sequence data. More...
 
char * InitErrorStr
 initialization error string More...
 

Detailed Description

Complete type definition of Blast Sequence Source ADT.

The members of this structure should only be accessed by BlastSeqSrc implementations using the _BlastSeqSrcImpl_* functions.

Definition at line 43 of file blast_seqsrc.c.

Member Data Documentation

◆ CopyFnPtr

BlastSeqSrcCopier BlastSeqSrc::CopyFnPtr

Copier.

Definition at line 47 of file blast_seqsrc.c.

Referenced by BlastSeqSrcCopy().

◆ DataStructure

void* BlastSeqSrc::DataStructure

◆ DeleteFnPtr

BlastSeqSrcDestructor BlastSeqSrc::DeleteFnPtr

Destructor.

Definition at line 46 of file blast_seqsrc.c.

Referenced by BlastSeqSrcFree().

◆ GetAvgSeqLen

GetInt4FnPtr BlastSeqSrc::GetAvgSeqLen

Get average length of sequences in the set.

Definition at line 57 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetAvgSeqLen().

◆ GetIsProt

GetBoolFnPtr BlastSeqSrc::GetIsProt

Find if database is a protein or nucleotide.

Definition at line 62 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetIsProt().

◆ GetMaxSeqLen

GetInt4FnPtr BlastSeqSrc::GetMaxSeqLen

Get length of longest seq in set.

Definition at line 55 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetMaxSeqLen().

◆ GetMinSeqLen

GetInt4FnPtr BlastSeqSrc::GetMinSeqLen

Get length of longest seq in set.

Definition at line 56 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetMinSeqLen().

◆ GetName

GetStrFnPtr BlastSeqSrc::GetName

Get the name of the database.

Definition at line 61 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetName().

◆ GetNumSeqs

GetInt4FnPtr BlastSeqSrc::GetNumSeqs

Get number of sequences in set.

Definition at line 53 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetNumSeqs().

◆ GetNumSeqsStats

GetInt4FnPtr BlastSeqSrc::GetNumSeqsStats

Number of sequences for statistical purposes.

Definition at line 54 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetNumSeqsStats().

◆ GetSeqLen

GetInt4FnPtr BlastSeqSrc::GetSeqLen

Retrieve given sequence length.

Definition at line 71 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetSeqLen().

◆ GetSequence

GetSeqBlkFnPtr BlastSeqSrc::GetSequence

Retrieve individual sequence.

Definition at line 70 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetSequence().

◆ GetSupportsPartialFetching

GetBoolFnPtr BlastSeqSrc::GetSupportsPartialFetching

Find if database supports partial fetching.

Definition at line 66 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetSupportsPartialFetching().

◆ GetTotLen

GetInt8FnPtr BlastSeqSrc::GetTotLen

Get tot length of all seqs in set.

Definition at line 59 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetTotLen().

◆ GetTotLenStats

GetInt8FnPtr BlastSeqSrc::GetTotLenStats

Total length of all seqs for statistical purposes.

Definition at line 60 of file blast_seqsrc.c.

Referenced by BlastSeqSrcGetTotLenStats().

◆ InitErrorStr

char* BlastSeqSrc::InitErrorStr

initialization error string

Definition at line 84 of file blast_seqsrc.c.

Referenced by BlastSeqSrcFree(), and BlastSeqSrcGetInitError().

◆ IterNext

AdvanceIteratorFnPtr BlastSeqSrc::IterNext

Gets next oid from the iterator.

Definition at line 76 of file blast_seqsrc.c.

Referenced by BlastSeqSrcIteratorNext().

◆ NewFnPtr

BlastSeqSrcConstructor BlastSeqSrc::NewFnPtr

Constructor.

Definition at line 45 of file blast_seqsrc.c.

Referenced by BlastSeqSrcNew().

◆ ReleaseSequence

ReleaseSeqBlkFnPtr BlastSeqSrc::ReleaseSequence

Deallocate individual sequence (if applicable)

Definition at line 72 of file blast_seqsrc.c.

Referenced by BlastSeqSrcReleaseSequence().

◆ ResetChunkIterator

ResetChunkIteratorFnPtr BlastSeqSrc::ResetChunkIterator

Reset the implementation's chunk "bookmark".

Definition at line 78 of file blast_seqsrc.c.

Referenced by BlastSeqSrcResetChunkIterator().

◆ SetNumberOfThreads

SetInt4FnPtr BlastSeqSrc::SetNumberOfThreads

Set number of threads.

Definition at line 50 of file blast_seqsrc.c.

Referenced by BlastSeqSrcSetNumberOfThreads().

◆ SetSeqRange

SetSeqRangeFnPtr BlastSeqSrc::SetSeqRange

Setting ranges for partial fetching.

Definition at line 67 of file blast_seqsrc.c.

Referenced by BlastSeqSrcSetSeqRanges().


The documentation for this struct was generated from the following file:
Modified on Fri Jul 19 17:09:27 2024 by modify_doxy.py rev. 669887