NCBI C++ ToolKit
Classes | Public Member Functions | Protected Attributes | List of all members
CMaskReader Class Referenceabstract

Search Toolkit Book for CMaskReader

Virtual base class for all input readers. More...

#include <objtools/seqmasks_io/mask_reader.hpp>

+ Inheritance diagram for CMaskReader:

Classes

class  Exception
 Exceptions thrown by CMaskReader class. More...
 

Public Member Functions

 CMaskReader (CNcbiIstream &newInputStream)
 Object constructor. More...
 
virtual ~CMaskReader ()
 Object destructor. More...
 
virtual CRef< objects::CSeq_entry > GetNextSequence ()=0
 Read the next sequence from the source stream. More...
 

Protected Attributes

CNcbiIstreaminput_stream
 

Detailed Description

Virtual base class for all input readers.

Each derived class should implement GetNextSequence() interface to supply new sequences to the user.

Definition at line 49 of file mask_reader.hpp.

Constructor & Destructor Documentation

◆ CMaskReader()

CMaskReader::CMaskReader ( CNcbiIstream newInputStream)
inline

Object constructor.

Parameters
newInputStreamiostream object from which the data will be read. The format of the data is determined by the implementation.

Definition at line 89 of file mask_reader.hpp.

◆ ~CMaskReader()

virtual CMaskReader::~CMaskReader ( )
inlinevirtual

Object destructor.

Definition at line 95 of file mask_reader.hpp.

Member Function Documentation

◆ GetNextSequence()

virtual CRef< objects::CSeq_entry > CMaskReader::GetNextSequence ( )
pure virtual

Read the next sequence from the source stream.

Returns
Pointer (reference counting) to the next biological sequence entry read from the data source. Returns CRef< CSeq_entry >( null ) if no more data is available.

Implemented in CMaskFastaReader, and CMaskBDBReader.

Referenced by CDustMaskApplication::Run(), and CWinMaskApplication::Run().

Member Data Documentation

◆ input_stream

CNcbiIstream& CMaskReader::input_stream
protected

Definition at line 114 of file mask_reader.hpp.

Referenced by CMaskFastaReader::GetNextSequence().


The documentation for this class was generated from the following file:
Modified on Tue Apr 16 20:08:04 2024 by modify_doxy.py rev. 669887