NCBI C++ ToolKit
Public Types | Public Member Functions | Private Attributes | List of all members
CSDustMasker Class Reference

Search Toolkit Book for CSDustMasker

This class encapsulates the dusting functionality of winmask. More...

#include "win_mask_sdust_masker.hpp"
(Private to src/app/winmasker.)

+ Collaboration diagram for CSDustMasker:

Public Types

typedef CSeqMasker::TMaskedInterval TMaskedInterval
 Type representing a masked subsequence of a sequence. More...
 
typedef CSeqMasker::TMaskList TMaskList
 Type representing a list of masked segments. More...
 

Public Member Functions

 CSDustMasker (Uint4 window, Uint4 level, Uint4 linker)
 Object constructor. More...
 
 ~CSDustMasker ()
 Object destructor. More...
 
TMaskListoperator() (const objects::CSeqVector &data, const TMaskList &exclude_ranges)
 Function performing the actual dusting. More...
 

Private Attributes

Uint4 window
 
CSymDustMasker duster_
 

Detailed Description

This class encapsulates the dusting functionality of winmask.

Definition at line 49 of file win_mask_sdust_masker.hpp.

Member Typedef Documentation

◆ TMaskedInterval

Type representing a masked subsequence of a sequence.

Definition at line 54 of file win_mask_sdust_masker.hpp.

◆ TMaskList

Type representing a list of masked segments.

Definition at line 57 of file win_mask_sdust_masker.hpp.

Constructor & Destructor Documentation

◆ CSDustMasker()

CSDustMasker::CSDustMasker ( Uint4  window,
Uint4  level,
Uint4  linker 
)

Object constructor.

Parameters
windowdust window
leveldust level
linkerdust linker

Definition at line 67 of file win_mask_sdust_masker.cpp.

◆ ~CSDustMasker()

CSDustMasker::~CSDustMasker ( )

Object destructor.

Definition at line 72 of file win_mask_sdust_masker.cpp.

Member Function Documentation

◆ operator()()

CSDustMasker::TMaskList * CSDustMasker::operator() ( const objects::CSeqVector &  data,
const TMaskList exclude_ranges 
)

Function performing the actual dusting.

Parameters
datasequence data in IUPACNA format
Returns
pointer to a list of dusted sequences

Definition at line 75 of file win_mask_sdust_masker.cpp.

References data, duster_, result, and window.

Member Data Documentation

◆ duster_

CSymDustMasker CSDustMasker::duster_
private

Definition at line 89 of file win_mask_sdust_masker.hpp.

Referenced by operator()().

◆ window

Uint4 CSDustMasker::window
private

Definition at line 87 of file win_mask_sdust_masker.hpp.

Referenced by operator()().


The documentation for this class was generated from the following files:
Modified on Fri Apr 12 17:20:09 2024 by modify_doxy.py rev. 669887