NCBI C++ ToolKit
Protected Member Functions | Friends
CBlastInputSource Class Reference

Search Toolkit Book for CBlastInputSource

Base class representing a source of biological sequences. More...

#include <algo/blast/blastinput/blast_input.hpp>

+ Inheritance diagram for CBlastInputSource:
+ Collaboration diagram for CBlastInputSource:

List of all members.

Protected Member Functions

virtual ~CBlastInputSource ()
 Destructor.
virtual SSeqLoc GetNextSSeqLoc (CScope &scope)=0
 Retrieve a single sequence (in an SSeqLoc container)
virtual CRef< CBlastSearchQueryGetNextSequence (CScope &scope)=0
 Retrieve a single sequence (in a CBlastSearchQuery container)
virtual bool End ()=0
 Signal whether there are any unread sequence left.

Friends

class CBlastInput
 Declare CBlastInput as a friend.

Detailed Description

Base class representing a source of biological sequences.

Definition at line 246 of file blast_input.hpp.


Constructor & Destructor Documentation

virtual CBlastInputSource::~CBlastInputSource ( ) [inline, protected, virtual]

Destructor.

Definition at line 251 of file blast_input.hpp.


Member Function Documentation

virtual bool CBlastInputSource::End ( ) [protected, pure virtual]

Signal whether there are any unread sequence left.

Returns:
true if no unread sequences remaining

Implemented in CBlastFastaInputSource.

virtual CRef<CBlastSearchQuery> CBlastInputSource::GetNextSequence ( CScope scope) [protected, pure virtual]

Retrieve a single sequence (in a CBlastSearchQuery container)

Parameters:
scopeCScope object to use in CBlastSearchQuery returned [in]
Note:
Embedded Seq-loc returned must be of type interval or whole

Implemented in CBlastFastaInputSource.

Referenced by CBlastInput::GetAllSeqs(), and CBlastInput::GetNextSeqBatch().

virtual SSeqLoc CBlastInputSource::GetNextSSeqLoc ( CScope scope) [protected, pure virtual]

Retrieve a single sequence (in an SSeqLoc container)

Parameters:
scopeCScope object to use in SSeqLoc returned [in]
Note:
Embedded Seq-loc returned must be of type interval or whole

Implemented in CBlastFastaInputSource.

Referenced by CBlastInput::GetAllSeqLocs(), and CBlastInput::GetNextSeqLocBatch().


Friends And Related Function Documentation

friend class CBlastInput [friend]

Declare CBlastInput as a friend.

Definition at line 268 of file blast_input.hpp.


The documentation for this class was generated from the following file:
Modified on Sat Jul 12 17:04:01 2014 by modify_doxy.py rev. 426318