NCBI C++ ToolKit
Public Member Functions | List of all members
CWinMaskUtil::CIdSet Class Referenceabstract

Search Toolkit Book for CWinMaskUtil::CIdSet

Base class for sets of seq_id representations used with -ids and -exclude-ids options. More...

#include <algo/winmask/win_mask_util.hpp>

+ Inheritance diagram for CWinMaskUtil::CIdSet:

Public Member Functions

virtual ~CIdSet ()
 Object destructor. More...
 
virtual void insert (const string &id_str)=0
 Add a string to the id set. More...
 
virtual bool empty () const =0
 Check if the id set is empty. More...
 
virtual bool find (const objects::CBioseq_Handle &bsh) const =0
 Check if the id of the given bioseq is in the id set. More...
 

Detailed Description

Base class for sets of seq_id representations used with -ids and -exclude-ids options.

Definition at line 57 of file win_mask_util.hpp.

Constructor & Destructor Documentation

◆ ~CIdSet()

virtual CWinMaskUtil::CIdSet::~CIdSet ( )
inlinevirtual

Object destructor.

Definition at line 63 of file win_mask_util.hpp.

Member Function Documentation

◆ empty()

virtual bool CWinMaskUtil::CIdSet::empty ( ) const
pure virtual

Check if the id set is empty.

Returns
true if the id set is empty, false otherwise

Implemented in CWinMaskUtil::CIdSet_TextMatch, and CWinMaskUtil::CIdSet_SeqId.

Referenced by CWinMaskUtil::consider().

◆ find()

virtual bool CWinMaskUtil::CIdSet::find ( const objects::CBioseq_Handle &  bsh) const
pure virtual

Check if the id of the given bioseq is in the id set.

Parameters
bshbioseq handle which id is to be checked
Returns
true if the id of the bsh is found in the id set; false otherwise

Implemented in CWinMaskUtil::CIdSet_TextMatch, and CWinMaskUtil::CIdSet_SeqId.

Referenced by CWinMaskUtil::consider().

◆ insert()

virtual void CWinMaskUtil::CIdSet::insert ( const string id_str)
pure virtual

Add a string to the id set.

Parameters
id_strid to add

Implemented in CWinMaskUtil::CIdSet_TextMatch, and CWinMaskUtil::CIdSet_SeqId.

Referenced by CWinMaskConfig::FillIdList().


The documentation for this class was generated from the following file:
Modified on Thu Jun 13 17:32:14 2024 by modify_doxy.py rev. 669887